DataBag

Account

addAccount

Add a new account. Basic auth will be used for the accounts username and password. Access granted to valid create account token.

/account/profile

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Basic [[basicHash]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//account/profile"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

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

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");


        AccountApi apiInstance = new AccountApi();
        try {
            Profile result = apiInstance.addAccount();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#addAccount");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        try {
            Profile result = apiInstance.addAccount();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#addAccount");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

AccountApi *apiInstance = [[AccountApi alloc] init];

[apiInstance addAccountWithCompletionHandler: 
              ^(Profile output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'


var api = new DataBag.AccountApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addAccount(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addAccountExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AccountApi();

            try
            {
                Profile result = apiInstance.addAccount();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.addAccount: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiAccountApi();

try {
    $result = $api_instance->addAccount();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->addAccount: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AccountApi->new();

eval { 
    my $result = $api_instance->addAccount();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->addAccount: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AccountApi()

try: 
    api_response = api_instance.add_account()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->addAccount: %s\n" % e)

Parameters

Responses

Status: 201 - successful operation

Schema

Status: 400 - invalid handle or password

Status: 401 - invalid bearer token

Status: 500 - internal server error

addAccountApp

Generate token to attach an app to the account. Access granted to account's username and password.

/account/apps

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"//account/apps"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

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

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

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

import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        try {
            'String' result = apiInstance.addAccountApp();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#addAccountApp");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

AccountApi *apiInstance = [[AccountApi alloc] init];

[apiInstance addAccountAppWithCompletionHandler: 
              ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new DataBag.AccountApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addAccountApp(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addAccountAppExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AccountApi();

            try
            {
                'String' result = apiInstance.addAccountApp();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.addAccountApp: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiAccountApi();

try {
    $result = $api_instance->addAccountApp();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->addAccountApp: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AccountApi->new();

eval { 
    my $result = $api_instance->addAccountApp();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->addAccountApp: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AccountApi()

try: 
    api_response = api_instance.add_account_app()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->addAccountApp: %s\n" % e)

Parameters

Responses

Status: 201 - generated

Schema

Status: 401 - invalid password

Status: 500 - internal server error

addAccountAuthentication

Generate token to reset authentication. Access granted to account's login and password.

/account/auth

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"//account/auth"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

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

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

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

import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        try {
            'String' result = apiInstance.addAccountAuthentication();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#addAccountAuthentication");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

AccountApi *apiInstance = [[AccountApi alloc] init];

[apiInstance addAccountAuthenticationWithCompletionHandler: 
              ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new DataBag.AccountApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addAccountAuthentication(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addAccountAuthenticationExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AccountApi();

            try
            {
                'String' result = apiInstance.addAccountAuthentication();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.addAccountAuthentication: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiAccountApi();

try {
    $result = $api_instance->addAccountAuthentication();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->addAccountAuthentication: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AccountApi->new();

eval { 
    my $result = $api_instance->addAccountAuthentication();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->addAccountAuthentication: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AccountApi()

try: 
    api_response = api_instance.add_account_authentication()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->addAccountAuthentication: %s\n" % e)

Parameters

Responses

Status: 201 - generated

Schema

Status: 401 - invalid password

Status: 500 - internal server error

getAccountApps

Get list of attached apps to account. Access granted to account's username and password.

/account/apps

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"//account/apps"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

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

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        AccountApi apiInstance = new AccountApi();
        try {
            array[App] result = apiInstance.getAccountApps();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#getAccountApps");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        try {
            array[App] result = apiInstance.getAccountApps();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#getAccountApps");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

AccountApi *apiInstance = [[AccountApi alloc] init];

[apiInstance getAccountAppsWithCompletionHandler: 
              ^(array[App] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new DataBag.AccountApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountApps(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountAppsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AccountApi();

            try
            {
                array[App] result = apiInstance.getAccountApps();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.getAccountApps: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiAccountApi();

try {
    $result = $api_instance->getAccountApps();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->getAccountApps: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AccountApi->new();

eval { 
    my $result = $api_instance->getAccountApps();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->getAccountApps: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AccountApi()

try: 
    api_response = api_instance.get_account_apps()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->getAccountApps: %s\n" % e)

Parameters

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 500 - internal server error

getAccountImage

Get profile image. Access granted to account's username and password

/account/profile/image

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/octet-stream"\
"//account/profile/image"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

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

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        AccountApi apiInstance = new AccountApi();
        try {
            byte[] result = apiInstance.getAccountImage();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#getAccountImage");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        try {
            byte[] result = apiInstance.getAccountImage();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#getAccountImage");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

AccountApi *apiInstance = [[AccountApi alloc] init];

[apiInstance getAccountImageWithCompletionHandler: 
              ^(byte[] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new DataBag.AccountApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountImage(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountImageExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AccountApi();

            try
            {
                byte[] result = apiInstance.getAccountImage();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.getAccountImage: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiAccountApi();

try {
    $result = $api_instance->getAccountImage();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->getAccountImage: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AccountApi->new();

eval { 
    my $result = $api_instance->getAccountImage();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->getAccountImage: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AccountApi()

try: 
    api_response = api_instance.get_account_image()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->getAccountImage: %s\n" % e)

Parameters

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 405 - invalid image

Status: 500 - internal server error

getAccountProfile

Get account profile. Access granted to account's username and password.

/account/profile

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"//account/profile"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

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

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        AccountApi apiInstance = new AccountApi();
        try {
            Profile result = apiInstance.getAccountProfile();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#getAccountProfile");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        try {
            Profile result = apiInstance.getAccountProfile();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#getAccountProfile");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

AccountApi *apiInstance = [[AccountApi alloc] init];

[apiInstance getAccountProfileWithCompletionHandler: 
              ^(Profile output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new DataBag.AccountApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountProfile(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountProfileExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AccountApi();

            try
            {
                Profile result = apiInstance.getAccountProfile();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.getAccountProfile: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiAccountApi();

try {
    $result = $api_instance->getAccountProfile();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->getAccountProfile: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AccountApi->new();

eval { 
    my $result = $api_instance->getAccountProfile();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->getAccountProfile: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AccountApi()

try: 
    api_response = api_instance.get_account_profile()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->getAccountProfile: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation

Schema

Status: 401 - authentication error

Status: 500 - internal server error

getAccountToken

Check if account reset token or account create token is valid. Access granted to valid create or reset token.

/account/token

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
"//account/token"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

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

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AccountApi apiInstance = new AccountApi();
        try {
            apiInstance.getAccountToken();
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#getAccountToken");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        try {
            apiInstance.getAccountToken();
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#getAccountToken");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

AccountApi *apiInstance = [[AccountApi alloc] init];

[apiInstance getAccountTokenWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.AccountApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getAccountToken(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new AccountApi();

            try
            {
                apiInstance.getAccountToken();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.getAccountToken: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAccountApi();

try {
    $api_instance->getAccountToken();
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->getAccountToken: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;


my $api_instance = WWW::SwaggerClient::AccountApi->new();

eval { 
    $api_instance->getAccountToken();
};
if ($@) {
    warn "Exception when calling AccountApi->getAccountToken: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.AccountApi()

try: 
    api_instance.get_account_token()
except ApiException as e:
    print("Exception when calling AccountApi->getAccountToken: %s\n" % e)

Parameters

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 500 - internal server error

getAccountUsername

Check if username is available. Access granted account reset token or account create token.

/account/claimable

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
"//account/claimable?username="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

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

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AccountApi apiInstance = new AccountApi();
        String username = username_example; // String | username to check
        try {
            apiInstance.getAccountUsername(username);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#getAccountUsername");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        String username = username_example; // String | username to check
        try {
            apiInstance.getAccountUsername(username);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#getAccountUsername");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *username = username_example; // username to check

AccountApi *apiInstance = [[AccountApi alloc] init];

[apiInstance getAccountUsernameWith:username
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.AccountApi()
var username = username_example; // {{String}} username to check

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getAccountUsername(username, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new AccountApi();
            var username = username_example;  // String | username to check

            try
            {
                apiInstance.getAccountUsername(username);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.getAccountUsername: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAccountApi();
$username = username_example; // String | username to check

try {
    $api_instance->getAccountUsername($username);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->getAccountUsername: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;


my $api_instance = WWW::SwaggerClient::AccountApi->new();
my $username = username_example; # String | username to check

eval { 
    $api_instance->getAccountUsername(username => $username);
};
if ($@) {
    warn "Exception when calling AccountApi->getAccountUsername: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.AccountApi()
username = username_example # String | username to check

try: 
    api_instance.get_account_username(username)
except ApiException as e:
    print("Exception when calling AccountApi->getAccountUsername: %s\n" % e)

Parameters

Query parameters

Name	Description
username*	String username to check Required

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 406 - username already claimed

Status: 500 - internal server error

removeAccountApp

Get list of attached apps. Access granted to account's username and password.

/account/apps/{appId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Basic [[basicHash]]"\
"//account/apps/{appId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

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

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        AccountApi apiInstance = new AccountApi();
        String appId = appId_example; // String | specified app id
        try {
            apiInstance.removeAccountApp(appId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#removeAccountApp");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        String appId = appId_example; // String | specified app id
        try {
            apiInstance.removeAccountApp(appId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#removeAccountApp");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *appId = appId_example; // specified app id

AccountApi *apiInstance = [[AccountApi alloc] init];

[apiInstance removeAccountAppWith:appId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new DataBag.AccountApi()
var appId = appId_example; // {{String}} specified app id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeAccountApp(appId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeAccountAppExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AccountApi();
            var appId = appId_example;  // String | specified app id

            try
            {
                apiInstance.removeAccountApp(appId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.removeAccountApp: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiAccountApi();
$appId = appId_example; // String | specified app id

try {
    $api_instance->removeAccountApp($appId);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->removeAccountApp: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AccountApi->new();
my $appId = appId_example; # String | specified app id

eval { 
    $api_instance->removeAccountApp(appId => $appId);
};
if ($@) {
    warn "Exception when calling AccountApi->removeAccountApp: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AccountApi()
appId = appId_example # String | specified app id

try: 
    api_instance.remove_account_app(appId)
except ApiException as e:
    print("Exception when calling AccountApi->removeAccountApp: %s\n" % e)

Parameters

Path parameters

Name	Description
appId*	String specified app id Required

Responses

Status: 200 - successful operation

Status: 401 - invalid password

Status: 404 - app not found

Status: 500 - internal server error

setAccountApp

Apply the token to attach an app to the account. Access granted to valid attach token.

/account/apps

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//account/apps"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

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

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AccountApi apiInstance = new AccountApi();
        AppData body = ; // AppData | 
        try {
            'String' result = apiInstance.setAccountApp(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#setAccountApp");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        AppData body = ; // AppData | 
        try {
            'String' result = apiInstance.setAccountApp(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#setAccountApp");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
AppData *body = ; //  (optional)

AccountApi *apiInstance = [[AccountApi alloc] init];

[apiInstance setAccountAppWith:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.AccountApi()
var opts = { 
  'body':  // {{AppData}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setAccountApp(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new AccountApi();
            var body = new AppData(); // AppData |  (optional) 

            try
            {
                'String' result = apiInstance.setAccountApp(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.setAccountApp: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAccountApi();
$body = ; // AppData | 

try {
    $result = $api_instance->setAccountApp($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->setAccountApp: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;


my $api_instance = WWW::SwaggerClient::AccountApi->new();
my $body = WWW::SwaggerClient::Object::AppData->new(); # AppData | 

eval { 
    my $result = $api_instance->setAccountApp(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->setAccountApp: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.AccountApi()
body =  # AppData |  (optional)

try: 
    api_response = api_instance.set_account_app(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->setAccountApp: %s\n" % e)

Parameters

Body parameters

Name	Description
body

Responses

Status: 201 - generated

Schema

Status: 401 - invalid token

Status: 406 - app limit reached

Status: 500 - internal server error

setAccountAuthentication

Apply account reset token to set handle and password. Basic auth will be used for new login and password. Access granted to valid reset token.

/account/auth

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Basic [[basicHash]]"\
 -H "Authorization: Bearer [[accessToken]]"\
"//account/auth"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

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

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");


        AccountApi apiInstance = new AccountApi();
        try {
            apiInstance.setAccountAuthentication();
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#setAccountAuthentication");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        try {
            apiInstance.setAccountAuthentication();
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#setAccountAuthentication");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

AccountApi *apiInstance = [[AccountApi alloc] init];

[apiInstance setAccountAuthenticationWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'


var api = new DataBag.AccountApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setAccountAuthentication(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setAccountAuthenticationExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AccountApi();

            try
            {
                apiInstance.setAccountAuthentication();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.setAccountAuthentication: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiAccountApi();

try {
    $api_instance->setAccountAuthentication();
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->setAccountAuthentication: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AccountApi->new();

eval { 
    $api_instance->setAccountAuthentication();
};
if ($@) {
    warn "Exception when calling AccountApi->setAccountAuthentication: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AccountApi()

try: 
    api_instance.set_account_authentication()
except ApiException as e:
    print("Exception when calling AccountApi->setAccountAuthentication: %s\n" % e)

Parameters

Responses

Status: 201 - success

Status: 401 - permission denied

Status: 500 - internal server error

Admin

addNodeAccount

Gernerate a url for creating a new account. Access granted to admin username and password.

/admin/accounts

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"//admin/accounts"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

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

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

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

import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        try {
            'String' result = apiInstance.addNodeAccount();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#addNodeAccount");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

AdminApi *apiInstance = [[AdminApi alloc] init];

[apiInstance addNodeAccountWithCompletionHandler: 
              ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new DataBag.AdminApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addNodeAccount(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addNodeAccountExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AdminApi();

            try
            {
                'String' result = apiInstance.addNodeAccount();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.addNodeAccount: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiAdminApi();

try {
    $result = $api_instance->addNodeAccount();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->addNodeAccount: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AdminApi->new();

eval { 
    my $result = $api_instance->addNodeAccount();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->addNodeAccount: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AdminApi()

try: 
    api_response = api_instance.add_node_account()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->addNodeAccount: %s\n" % e)

Parameters

Responses

Status: 201 - generated

Schema

Status: 401 - invalid password

Status: 500 - internal server error

getNodeAccountImage

Get profile image of specified account. Access granted to admin username and password

/admin/accounts/{accountId}/image

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/octet-stream"\
"//admin/accounts/{accountId}/image"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

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

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        AdminApi apiInstance = new AdminApi();
        String accountId = accountId_example; // String | id of specified account
        try {
            byte[] result = apiInstance.getNodeAccountImage(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#getNodeAccountImage");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        String accountId = accountId_example; // String | id of specified account
        try {
            byte[] result = apiInstance.getNodeAccountImage(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#getNodeAccountImage");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *accountId = accountId_example; // id of specified account

AdminApi *apiInstance = [[AdminApi alloc] init];

[apiInstance getNodeAccountImageWith:accountId
              completionHandler: ^(byte[] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new DataBag.AdminApi()
var accountId = accountId_example; // {{String}} id of specified account

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNodeAccountImage(accountId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getNodeAccountImageExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AdminApi();
            var accountId = accountId_example;  // String | id of specified account

            try
            {
                byte[] result = apiInstance.getNodeAccountImage(accountId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.getNodeAccountImage: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiAdminApi();
$accountId = accountId_example; // String | id of specified account

try {
    $result = $api_instance->getNodeAccountImage($accountId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->getNodeAccountImage: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $accountId = accountId_example; # String | id of specified account

eval { 
    my $result = $api_instance->getNodeAccountImage(accountId => $accountId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->getNodeAccountImage: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AdminApi()
accountId = accountId_example # String | id of specified account

try: 
    api_response = api_instance.get_node_account_image(accountId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->getNodeAccountImage: %s\n" % e)

Parameters

Path parameters

Name	Description
accountId*	String id of specified account Required

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 405 - invalid image

Status: 500 - internal server error

getNodeAccounts

Get list of accounts hosted on node. Access granted to admin username and password.

/admin/accounts

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"//admin/accounts"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

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

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        AdminApi apiInstance = new AdminApi();
        try {
            array[Account] result = apiInstance.getNodeAccounts();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#getNodeAccounts");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        try {
            array[Account] result = apiInstance.getNodeAccounts();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#getNodeAccounts");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

AdminApi *apiInstance = [[AdminApi alloc] init];

[apiInstance getNodeAccountsWithCompletionHandler: 
              ^(array[Account] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new DataBag.AdminApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNodeAccounts(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getNodeAccountsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AdminApi();

            try
            {
                array[Account] result = apiInstance.getNodeAccounts();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.getNodeAccounts: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiAdminApi();

try {
    $result = $api_instance->getNodeAccounts();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->getNodeAccounts: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AdminApi->new();

eval { 
    my $result = $api_instance->getNodeAccounts();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->getNodeAccounts: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AdminApi()

try: 
    api_response = api_instance.get_node_accounts()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->getNodeAccounts: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation

Schema

Status: 401 - invalid password

Status: 404 - handle not found

Status: 500 - internal server error

getNodeClaimable

Check if portal params have been set

/admin/claimable

Usage and SDK Samples

curl -X GET\
"//admin/claimable"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

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

public class AdminApiExample {

    public static void main(String[] args) {
        
        AdminApi apiInstance = new AdminApi();
        try {
            apiInstance.getNodeClaimable();
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#getNodeClaimable");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        try {
            apiInstance.getNodeClaimable();
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#getNodeClaimable");
            e.printStackTrace();
        }
    }
}


AdminApi *apiInstance = [[AdminApi alloc] init];

[apiInstance getNodeClaimableWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');

var api = new DataBag.AdminApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getNodeClaimable(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AdminApi();

            try
            {
                apiInstance.getNodeClaimable();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.getNodeClaimable: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAdminApi();

try {
    $api_instance->getNodeClaimable();
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->getNodeClaimable: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

my $api_instance = WWW::SwaggerClient::AdminApi->new();

eval { 
    $api_instance->getNodeClaimable();
};
if ($@) {
    warn "Exception when calling AdminApi->getNodeClaimable: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AdminApi()

try: 
    api_instance.get_node_claimable()
except ApiException as e:
    print("Exception when calling AdminApi->getNodeClaimable: %s\n" % e)

Parameters

Responses

Status: 200 - success

Status: 406 - node already claimed

Status: 500 - internal server error

removeNodeAccount

Remove account from node. Access granted to admin username and password.

/admin/accounts/{accountId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Basic [[basicHash]]"\
"//admin/accounts/{accountId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

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

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        AdminApi apiInstance = new AdminApi();
        String accountId = accountId_example; // String | id of account to delete
        try {
            apiInstance.removeNodeAccount(accountId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#removeNodeAccount");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        String accountId = accountId_example; // String | id of account to delete
        try {
            apiInstance.removeNodeAccount(accountId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#removeNodeAccount");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *accountId = accountId_example; // id of account to delete

AdminApi *apiInstance = [[AdminApi alloc] init];

[apiInstance removeNodeAccountWith:accountId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new DataBag.AdminApi()
var accountId = accountId_example; // {{String}} id of account to delete

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeNodeAccount(accountId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeNodeAccountExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AdminApi();
            var accountId = accountId_example;  // String | id of account to delete

            try
            {
                apiInstance.removeNodeAccount(accountId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.removeNodeAccount: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiAdminApi();
$accountId = accountId_example; // String | id of account to delete

try {
    $api_instance->removeNodeAccount($accountId);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->removeNodeAccount: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $accountId = accountId_example; # String | id of account to delete

eval { 
    $api_instance->removeNodeAccount(accountId => $accountId);
};
if ($@) {
    warn "Exception when calling AdminApi->removeNodeAccount: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AdminApi()
accountId = accountId_example # String | id of account to delete

try: 
    api_instance.remove_node_account(accountId)
except ApiException as e:
    print("Exception when calling AdminApi->removeNodeAccount: %s\n" % e)

Parameters

Path parameters

Name	Description
accountId*	String id of account to delete Required

Responses

Status: 200 - successful operation

Status: 401 - invalid authentication

Status: 404 - account not found

Status: 500 - internal server error

setNodeAccount

Generate a password reset url for specified account. Access granted to admin username and password.

/admin/accounts/{accountId}/reset

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"//admin/accounts/{accountId}/reset"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

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

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        AdminApi apiInstance = new AdminApi();
        String accountId = accountId_example; // String | id of profile to access
        try {
            'String' result = apiInstance.setNodeAccount(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#setNodeAccount");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        String accountId = accountId_example; // String | id of profile to access
        try {
            'String' result = apiInstance.setNodeAccount(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#setNodeAccount");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *accountId = accountId_example; // id of profile to access

AdminApi *apiInstance = [[AdminApi alloc] init];

[apiInstance setNodeAccountWith:accountId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new DataBag.AdminApi()
var accountId = accountId_example; // {{String}} id of profile to access

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setNodeAccount(accountId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setNodeAccountExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AdminApi();
            var accountId = accountId_example;  // String | id of profile to access

            try
            {
                'String' result = apiInstance.setNodeAccount(accountId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.setNodeAccount: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiAdminApi();
$accountId = accountId_example; // String | id of profile to access

try {
    $result = $api_instance->setNodeAccount($accountId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->setNodeAccount: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $accountId = accountId_example; # String | id of profile to access

eval { 
    my $result = $api_instance->setNodeAccount(accountId => $accountId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->setNodeAccount: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AdminApi()
accountId = accountId_example # String | id of profile to access

try: 
    api_response = api_instance.set_node_account(accountId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->setNodeAccount: %s\n" % e)

Parameters

Path parameters

Name	Description
accountId*	String id of profile to access Required

Responses

Status: 201 - generated

Schema

Status: 401 - invalid password

Status: 404 - unknown portal

Status: 500 - internal server error

setNodeConfig

Set admin password and node domain

/admin/config

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Basic [[basicHash]]"\
"//admin/config?domain="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

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

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        AdminApi apiInstance = new AdminApi();
        String domain = domain_example; // String | domain of node
        try {
            apiInstance.setNodeConfig(domain);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#setNodeConfig");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        String domain = domain_example; // String | domain of node
        try {
            apiInstance.setNodeConfig(domain);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#setNodeConfig");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *domain = domain_example; // domain of node

AdminApi *apiInstance = [[AdminApi alloc] init];

[apiInstance setNodeConfigWith:domain
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new DataBag.AdminApi()
var domain = domain_example; // {{String}} domain of node

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setNodeConfig(domain, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setNodeConfigExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AdminApi();
            var domain = domain_example;  // String | domain of node

            try
            {
                apiInstance.setNodeConfig(domain);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.setNodeConfig: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiAdminApi();
$domain = domain_example; // String | domain of node

try {
    $api_instance->setNodeConfig($domain);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->setNodeConfig: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $domain = domain_example; # String | domain of node

eval { 
    $api_instance->setNodeConfig(domain => $domain);
};
if ($@) {
    warn "Exception when calling AdminApi->setNodeConfig: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AdminApi()
domain = domain_example # String | domain of node

try: 
    api_instance.set_node_config(domain)
except ApiException as e:
    print("Exception when calling AdminApi->setNodeConfig: %s\n" % e)

Parameters

Query parameters

Name	Description
domain*	String domain of node Required

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 500 - internal server error

setNodeConfigDomain

Set portal domain to be set in profile queries. Access granted to admin username and password.

/admin/config/domain

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Basic [[basicHash]]"\
-H "Content-Type: application/json"\
"//admin/config/domain"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

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

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        AdminApi apiInstance = new AdminApi();
        String body = ; // String | 
        try {
            apiInstance.setNodeConfigDomain(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#setNodeConfigDomain");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        String body = ; // String | 
        try {
            apiInstance.setNodeConfigDomain(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#setNodeConfigDomain");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *body = ; //  (optional)

AdminApi *apiInstance = [[AdminApi alloc] init];

[apiInstance setNodeConfigDomainWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new DataBag.AdminApi()
var opts = { 
  'body':  // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setNodeConfigDomain(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setNodeConfigDomainExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AdminApi();
            var body = new String(); // String |  (optional) 

            try
            {
                apiInstance.setNodeConfigDomain(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.setNodeConfigDomain: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiAdminApi();
$body = ; // String | 

try {
    $api_instance->setNodeConfigDomain($body);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->setNodeConfigDomain: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $body = WWW::SwaggerClient::Object::String->new(); # String | 

eval { 
    $api_instance->setNodeConfigDomain(body => $body);
};
if ($@) {
    warn "Exception when calling AdminApi->setNodeConfigDomain: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AdminApi()
body =  # String |  (optional)

try: 
    api_instance.set_node_config_domain(body=body)
except ApiException as e:
    print("Exception when calling AdminApi->setNodeConfigDomain: %s\n" % e)

Parameters

Body parameters

Name	Description
body

Responses

Status: 200 - success

Status: 401 - permission denide

Status: 500 - internal server error

Authenticate

authenticate

Retrieve an authenticate data messaging verifying the account holder is accepting the action referenced by the token.

/authenticate

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//authenticate"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthenticateApi;

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

public class AuthenticateApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AuthenticateApi apiInstance = new AuthenticateApi();
        String body = ; // String | 
        try {
            DataMessage result = apiInstance.authenticate(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticateApi#authenticate");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AuthenticateApi;

public class AuthenticateApiExample {

    public static void main(String[] args) {
        AuthenticateApi apiInstance = new AuthenticateApi();
        String body = ; // String | 
        try {
            DataMessage result = apiInstance.authenticate(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticateApi#authenticate");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *body = ; //  (optional)

AuthenticateApi *apiInstance = [[AuthenticateApi alloc] init];

[apiInstance authenticateWith:body
              completionHandler: ^(DataMessage output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.AuthenticateApi()
var opts = { 
  'body':  // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.authenticate(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new AuthenticateApi();
            var body = new String(); // String |  (optional) 

            try
            {
                DataMessage result = apiInstance.authenticate(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthenticateApi.authenticate: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAuthenticateApi();
$body = ; // String | 

try {
    $result = $api_instance->authenticate($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticateApi->authenticate: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthenticateApi;


my $api_instance = WWW::SwaggerClient::AuthenticateApi->new();
my $body = WWW::SwaggerClient::Object::String->new(); # String | 

eval { 
    my $result = $api_instance->authenticate(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthenticateApi->authenticate: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.AuthenticateApi()
body =  # String |  (optional)

try: 
    api_response = api_instance.authenticate(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticateApi->authenticate: %s\n" % e)

Parameters

Body parameters

Name	Description
body

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 500 - internal server error

Contact

addCard

Add a contact card. Access granted to app tokens of account holder.

/contact/cards

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//contact/cards"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactApi;

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

public class ContactApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContactApi apiInstance = new ContactApi();
        try {
            DataMessage result = apiInstance.addCard();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#addCard");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContactApi;

public class ContactApiExample {

    public static void main(String[] args) {
        ContactApi apiInstance = new ContactApi();
        try {
            DataMessage result = apiInstance.addCard();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#addCard");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

ContactApi *apiInstance = [[ContactApi alloc] init];

[apiInstance addCardWithCompletionHandler: 
              ^(DataMessage output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContactApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addCard(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactApi();

            try
            {
                DataMessage result = apiInstance.addCard();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.addCard: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactApi();

try {
    $result = $api_instance->addCard();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactApi->addCard: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactApi;


my $api_instance = WWW::SwaggerClient::ContactApi->new();

eval { 
    my $result = $api_instance->addCard();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactApi->addCard: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContactApi()

try: 
    api_response = api_instance.add_card()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactApi->addCard: %s\n" % e)

Parameters

Responses

Status: 200 - success

Schema

Status: 400 - invalid data message

Status: 401 - permission denied

Status: 500 - internal server error

clearCardGroup

Clear sharing group for card. Access granted to app tokens for account holder.

/contact/cards/{cardId}/groups/{groupId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//contact/cards/{cardId}/groups/{groupId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactApi;

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

public class ContactApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContactApi apiInstance = new ContactApi();
        String cardId = cardId_example; // String | specified card id
        String groupId = groupId_example; // String | specified share id
        try {
            CardData result = apiInstance.clearCardGroup(cardId, groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#clearCardGroup");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContactApi;

public class ContactApiExample {

    public static void main(String[] args) {
        ContactApi apiInstance = new ContactApi();
        String cardId = cardId_example; // String | specified card id
        String groupId = groupId_example; // String | specified share id
        try {
            CardData result = apiInstance.clearCardGroup(cardId, groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#clearCardGroup");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *cardId = cardId_example; // specified card id
String *groupId = groupId_example; // specified share id

ContactApi *apiInstance = [[ContactApi alloc] init];

[apiInstance clearCardGroupWith:cardId
    groupId:groupId
              completionHandler: ^(CardData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContactApi()
var cardId = cardId_example; // {{String}} specified card id
var groupId = groupId_example; // {{String}} specified share id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.clearCardGroup(cardId, groupId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactApi();
            var cardId = cardId_example;  // String | specified card id
            var groupId = groupId_example;  // String | specified share id

            try
            {
                CardData result = apiInstance.clearCardGroup(cardId, groupId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.clearCardGroup: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactApi();
$cardId = cardId_example; // String | specified card id
$groupId = groupId_example; // String | specified share id

try {
    $result = $api_instance->clearCardGroup($cardId, $groupId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactApi->clearCardGroup: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactApi;


my $api_instance = WWW::SwaggerClient::ContactApi->new();
my $cardId = cardId_example; # String | specified card id
my $groupId = groupId_example; # String | specified share id

eval { 
    my $result = $api_instance->clearCardGroup(cardId => $cardId, groupId => $groupId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactApi->clearCardGroup: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContactApi()
cardId = cardId_example # String | specified card id
groupId = groupId_example # String | specified share id

try: 
    api_response = api_instance.clear_card_group(cardId, groupId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactApi->clearCardGroup: %s\n" % e)

Parameters

Path parameters

Name	Description
cardId*	String specified card id Required
groupId*	String specified share id Required

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 404 - card or group not found

Status: 500 - internal server error

clearCardNotes

Clear notes for specified card. Access granted to app tokens of account holder.

/contact/cards/{cardId}/notes

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//contact/cards/{cardId}/notes"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactApi;

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

public class ContactApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContactApi apiInstance = new ContactApi();
        String cardId = cardId_example; // String | specified card id
        try {
            CardData result = apiInstance.clearCardNotes(cardId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#clearCardNotes");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContactApi;

public class ContactApiExample {

    public static void main(String[] args) {
        ContactApi apiInstance = new ContactApi();
        String cardId = cardId_example; // String | specified card id
        try {
            CardData result = apiInstance.clearCardNotes(cardId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#clearCardNotes");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *cardId = cardId_example; // specified card id

ContactApi *apiInstance = [[ContactApi alloc] init];

[apiInstance clearCardNotesWith:cardId
              completionHandler: ^(CardData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContactApi()
var cardId = cardId_example; // {{String}} specified card id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.clearCardNotes(cardId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactApi();
            var cardId = cardId_example;  // String | specified card id

            try
            {
                CardData result = apiInstance.clearCardNotes(cardId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.clearCardNotes: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactApi();
$cardId = cardId_example; // String | specified card id

try {
    $result = $api_instance->clearCardNotes($cardId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactApi->clearCardNotes: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactApi;


my $api_instance = WWW::SwaggerClient::ContactApi->new();
my $cardId = cardId_example; # String | specified card id

eval { 
    my $result = $api_instance->clearCardNotes(cardId => $cardId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactApi->clearCardNotes: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContactApi()
cardId = cardId_example # String | specified card id

try: 
    api_response = api_instance.clear_card_notes(cardId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactApi->clearCardNotes: %s\n" % e)

Parameters

Path parameters

Name	Description
cardId*	String specified card id Required

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 404 - card not found

Status: 500 - internal server error

getCard

Retieve card entry. Permission granted to app tokens for account holder.

/contact/cards/{cardId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//contact/cards/{cardId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactApi;

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

public class ContactApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContactApi apiInstance = new ContactApi();
        String cardId = cardId_example; // String | specified card id
        try {
            Card result = apiInstance.getCard(cardId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#getCard");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContactApi;

public class ContactApiExample {

    public static void main(String[] args) {
        ContactApi apiInstance = new ContactApi();
        String cardId = cardId_example; // String | specified card id
        try {
            Card result = apiInstance.getCard(cardId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#getCard");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *cardId = cardId_example; // specified card id

ContactApi *apiInstance = [[ContactApi alloc] init];

[apiInstance getCardWith:cardId
              completionHandler: ^(Card output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContactApi()
var cardId = cardId_example; // {{String}} specified card id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCard(cardId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactApi();
            var cardId = cardId_example;  // String | specified card id

            try
            {
                Card result = apiInstance.getCard(cardId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.getCard: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactApi();
$cardId = cardId_example; // String | specified card id

try {
    $result = $api_instance->getCard($cardId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactApi->getCard: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactApi;


my $api_instance = WWW::SwaggerClient::ContactApi->new();
my $cardId = cardId_example; # String | specified card id

eval { 
    my $result = $api_instance->getCard(cardId => $cardId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactApi->getCard: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContactApi()
cardId = cardId_example # String | specified card id

try: 
    api_response = api_instance.get_card(cardId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactApi->getCard: %s\n" % e)

Parameters

Path parameters

Name	Description
cardId*	String specified card id Required

Responses

Status: 200 - successful operation

Schema

Status: 401 - permission denied

Status: 404 - card not found

Status: 500 - internal server error

getCardData

Get specified card data. Access granted to app tokens for account holder.

/contact/cards/{cardId}/data

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//contact/cards/{cardId}/data"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactApi;

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

public class ContactApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContactApi apiInstance = new ContactApi();
        String cardId = cardId_example; // String | specified card id
        try {
            CardData result = apiInstance.getCardData(cardId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#getCardData");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContactApi;

public class ContactApiExample {

    public static void main(String[] args) {
        ContactApi apiInstance = new ContactApi();
        String cardId = cardId_example; // String | specified card id
        try {
            CardData result = apiInstance.getCardData(cardId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#getCardData");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *cardId = cardId_example; // specified card id

ContactApi *apiInstance = [[ContactApi alloc] init];

[apiInstance getCardDataWith:cardId
              completionHandler: ^(CardData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContactApi()
var cardId = cardId_example; // {{String}} specified card id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCardData(cardId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactApi();
            var cardId = cardId_example;  // String | specified card id

            try
            {
                CardData result = apiInstance.getCardData(cardId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.getCardData: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactApi();
$cardId = cardId_example; // String | specified card id

try {
    $result = $api_instance->getCardData($cardId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactApi->getCardData: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactApi;


my $api_instance = WWW::SwaggerClient::ContactApi->new();
my $cardId = cardId_example; # String | specified card id

eval { 
    my $result = $api_instance->getCardData(cardId => $cardId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactApi->getCardData: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContactApi()
cardId = cardId_example # String | specified card id

try: 
    api_response = api_instance.get_card_data(cardId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactApi->getCardData: %s\n" % e)

Parameters

Path parameters

Name	Description
cardId*	String specified card id Required

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 404 - card not found

Status: 500 - internal server error

getCardProfile

Get profile of card entry. Access granted to app tokens of account holder.

/contact/cards/{cardId}/profile

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//contact/cards/{cardId}/profile"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactApi;

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

public class ContactApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContactApi apiInstance = new ContactApi();
        String cardId = cardId_example; // String | specified card id
        try {
            CardProfile result = apiInstance.getCardProfile(cardId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#getCardProfile");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContactApi;

public class ContactApiExample {

    public static void main(String[] args) {
        ContactApi apiInstance = new ContactApi();
        String cardId = cardId_example; // String | specified card id
        try {
            CardProfile result = apiInstance.getCardProfile(cardId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#getCardProfile");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *cardId = cardId_example; // specified card id

ContactApi *apiInstance = [[ContactApi alloc] init];

[apiInstance getCardProfileWith:cardId
              completionHandler: ^(CardProfile output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContactApi()
var cardId = cardId_example; // {{String}} specified card id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCardProfile(cardId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactApi();
            var cardId = cardId_example;  // String | specified card id

            try
            {
                CardProfile result = apiInstance.getCardProfile(cardId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.getCardProfile: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactApi();
$cardId = cardId_example; // String | specified card id

try {
    $result = $api_instance->getCardProfile($cardId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactApi->getCardProfile: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactApi;


my $api_instance = WWW::SwaggerClient::ContactApi->new();
my $cardId = cardId_example; # String | specified card id

eval { 
    my $result = $api_instance->getCardProfile(cardId => $cardId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactApi->getCardProfile: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContactApi()
cardId = cardId_example # String | specified card id

try: 
    api_response = api_instance.get_card_profile(cardId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactApi->getCardProfile: %s\n" % e)

Parameters

Path parameters

Name	Description
cardId*	String specified card id Required

Responses

Status: 200 - successful operation

Schema

Status: 401 - permission denied

Status: 404 - not found

Status: 500 - internal server error

getCardProfileImage

Get image of card profile. Access granted to app tokens of account holder.

/contact/cards/{cardId}/profile/image

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/octet-stream"\
"//contact/cards/{cardId}/profile/image"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactApi;

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

public class ContactApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContactApi apiInstance = new ContactApi();
        String cardId = cardId_example; // String | specified card id
        try {
            byte[] result = apiInstance.getCardProfileImage(cardId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#getCardProfileImage");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContactApi;

public class ContactApiExample {

    public static void main(String[] args) {
        ContactApi apiInstance = new ContactApi();
        String cardId = cardId_example; // String | specified card id
        try {
            byte[] result = apiInstance.getCardProfileImage(cardId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#getCardProfileImage");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *cardId = cardId_example; // specified card id

ContactApi *apiInstance = [[ContactApi alloc] init];

[apiInstance getCardProfileImageWith:cardId
              completionHandler: ^(byte[] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContactApi()
var cardId = cardId_example; // {{String}} specified card id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCardProfileImage(cardId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactApi();
            var cardId = cardId_example;  // String | specified card id

            try
            {
                byte[] result = apiInstance.getCardProfileImage(cardId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.getCardProfileImage: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactApi();
$cardId = cardId_example; // String | specified card id

try {
    $result = $api_instance->getCardProfileImage($cardId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactApi->getCardProfileImage: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactApi;


my $api_instance = WWW::SwaggerClient::ContactApi->new();
my $cardId = cardId_example; # String | specified card id

eval { 
    my $result = $api_instance->getCardProfileImage(cardId => $cardId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactApi->getCardProfileImage: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContactApi()
cardId = cardId_example # String | specified card id

try: 
    api_response = api_instance.get_card_profile_image(cardId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactApi->getCardProfileImage: %s\n" % e)

Parameters

Path parameters

Name	Description
cardId*	String specified card id Required

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 404 - card not found

Status: 405 - invalid image

Status: 500 - internal server error

getCardView

Get list of card views. Access granted to app tokens of account holder.

/contact/cards/view

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//contact/cards/view"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactApi;

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

public class ContactApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContactApi apiInstance = new ContactApi();
        try {
            array[CardView] result = apiInstance.getCardView();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#getCardView");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContactApi;

public class ContactApiExample {

    public static void main(String[] args) {
        ContactApi apiInstance = new ContactApi();
        try {
            array[CardView] result = apiInstance.getCardView();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#getCardView");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

ContactApi *apiInstance = [[ContactApi alloc] init];

[apiInstance getCardViewWithCompletionHandler: 
              ^(array[CardView] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContactApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCardView(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactApi();

            try
            {
                array[CardView] result = apiInstance.getCardView();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.getCardView: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactApi();

try {
    $result = $api_instance->getCardView();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactApi->getCardView: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactApi;


my $api_instance = WWW::SwaggerClient::ContactApi->new();

eval { 
    my $result = $api_instance->getCardView();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactApi->getCardView: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContactApi()

try: 
    api_response = api_instance.get_card_view()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactApi->getCardView: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation

Schema

Status: 401 - permission denied

Status: 500 - internal server error

getCloseMessage

Get message for closing connection with contact. Access granted to app tokens for account holder.

/contact/cards/{cardId}/closeMessage

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//contact/cards/{cardId}/closeMessage"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactApi;

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

public class ContactApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContactApi apiInstance = new ContactApi();
        String cardId = cardId_example; // String | specified card id
        try {
            DataMessage result = apiInstance.getCloseMessage(cardId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#getCloseMessage");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContactApi;

public class ContactApiExample {

    public static void main(String[] args) {
        ContactApi apiInstance = new ContactApi();
        String cardId = cardId_example; // String | specified card id
        try {
            DataMessage result = apiInstance.getCloseMessage(cardId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#getCloseMessage");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *cardId = cardId_example; // specified card id

ContactApi *apiInstance = [[ContactApi alloc] init];

[apiInstance getCloseMessageWith:cardId
              completionHandler: ^(DataMessage output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContactApi()
var cardId = cardId_example; // {{String}} specified card id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCloseMessage(cardId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactApi();
            var cardId = cardId_example;  // String | specified card id

            try
            {
                DataMessage result = apiInstance.getCloseMessage(cardId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.getCloseMessage: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactApi();
$cardId = cardId_example; // String | specified card id

try {
    $result = $api_instance->getCloseMessage($cardId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactApi->getCloseMessage: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactApi;


my $api_instance = WWW::SwaggerClient::ContactApi->new();
my $cardId = cardId_example; # String | specified card id

eval { 
    my $result = $api_instance->getCloseMessage(cardId => $cardId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactApi->getCloseMessage: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContactApi()
cardId = cardId_example # String | specified card id

try: 
    api_response = api_instance.get_close_message(cardId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactApi->getCloseMessage: %s\n" % e)

Parameters

Path parameters

Name	Description
cardId*	String specified card id Required

Responses

Status: 200 - successful operation

Schema

Status: 401 - permission denied

Status: 404 - card not found

Status: 500 - internal server error

getOpenMessage

Get message for connecting to other contacts. Access granted to app tokens for account holder.

/contact/cards/{cardId}/openMessage

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//contact/cards/{cardId}/openMessage"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactApi;

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

public class ContactApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContactApi apiInstance = new ContactApi();
        String cardId = cardId_example; // String | specified card id
        try {
            DataMessage result = apiInstance.getOpenMessage(cardId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#getOpenMessage");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContactApi;

public class ContactApiExample {

    public static void main(String[] args) {
        ContactApi apiInstance = new ContactApi();
        String cardId = cardId_example; // String | specified card id
        try {
            DataMessage result = apiInstance.getOpenMessage(cardId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#getOpenMessage");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *cardId = cardId_example; // specified card id

ContactApi *apiInstance = [[ContactApi alloc] init];

[apiInstance getOpenMessageWith:cardId
              completionHandler: ^(DataMessage output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContactApi()
var cardId = cardId_example; // {{String}} specified card id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOpenMessage(cardId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactApi();
            var cardId = cardId_example;  // String | specified card id

            try
            {
                DataMessage result = apiInstance.getOpenMessage(cardId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.getOpenMessage: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactApi();
$cardId = cardId_example; // String | specified card id

try {
    $result = $api_instance->getOpenMessage($cardId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactApi->getOpenMessage: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactApi;


my $api_instance = WWW::SwaggerClient::ContactApi->new();
my $cardId = cardId_example; # String | specified card id

eval { 
    my $result = $api_instance->getOpenMessage(cardId => $cardId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactApi->getOpenMessage: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContactApi()
cardId = cardId_example # String | specified card id

try: 
    api_response = api_instance.get_open_message(cardId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactApi->getOpenMessage: %s\n" % e)

Parameters

Path parameters

Name	Description
cardId*	String specified card id Required

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 404 - card not found

Status: 500 - internal server error

removeCard

Remove card entry. Access granted to app tokens of account holder.

/contact/cards/{cardId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
"//contact/cards/{cardId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactApi;

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

public class ContactApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContactApi apiInstance = new ContactApi();
        String cardId = cardId_example; // String | specified card id
        try {
            apiInstance.removeCard(cardId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#removeCard");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContactApi;

public class ContactApiExample {

    public static void main(String[] args) {
        ContactApi apiInstance = new ContactApi();
        String cardId = cardId_example; // String | specified card id
        try {
            apiInstance.removeCard(cardId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#removeCard");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *cardId = cardId_example; // specified card id

ContactApi *apiInstance = [[ContactApi alloc] init];

[apiInstance removeCardWith:cardId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContactApi()
var cardId = cardId_example; // {{String}} specified card id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeCard(cardId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactApi();
            var cardId = cardId_example;  // String | specified card id

            try
            {
                apiInstance.removeCard(cardId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.removeCard: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactApi();
$cardId = cardId_example; // String | specified card id

try {
    $api_instance->removeCard($cardId);
} catch (Exception $e) {
    echo 'Exception when calling ContactApi->removeCard: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactApi;


my $api_instance = WWW::SwaggerClient::ContactApi->new();
my $cardId = cardId_example; # String | specified card id

eval { 
    $api_instance->removeCard(cardId => $cardId);
};
if ($@) {
    warn "Exception when calling ContactApi->removeCard: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContactApi()
cardId = cardId_example # String | specified card id

try: 
    api_instance.remove_card(cardId)
except ApiException as e:
    print("Exception when calling ContactApi->removeCard: %s\n" % e)

Parameters

Path parameters

Name	Description
cardId*	String specified card id Required

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 404 - card not found

Status: 500 - internal server error

setCardGroup

Set sharing group for contact. Access granted to app tokens for account holder.

/contact/cards/{cardId}/groups/{groupId}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//contact/cards/{cardId}/groups/{groupId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactApi;

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

public class ContactApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContactApi apiInstance = new ContactApi();
        String cardId = cardId_example; // String | specified card id
        String groupId = groupId_example; // String | specified group id
        try {
            CardData result = apiInstance.setCardGroup(cardId, groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#setCardGroup");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContactApi;

public class ContactApiExample {

    public static void main(String[] args) {
        ContactApi apiInstance = new ContactApi();
        String cardId = cardId_example; // String | specified card id
        String groupId = groupId_example; // String | specified group id
        try {
            CardData result = apiInstance.setCardGroup(cardId, groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#setCardGroup");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *cardId = cardId_example; // specified card id
String *groupId = groupId_example; // specified group id

ContactApi *apiInstance = [[ContactApi alloc] init];

[apiInstance setCardGroupWith:cardId
    groupId:groupId
              completionHandler: ^(CardData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContactApi()
var cardId = cardId_example; // {{String}} specified card id
var groupId = groupId_example; // {{String}} specified group id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setCardGroup(cardId, groupId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactApi();
            var cardId = cardId_example;  // String | specified card id
            var groupId = groupId_example;  // String | specified group id

            try
            {
                CardData result = apiInstance.setCardGroup(cardId, groupId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.setCardGroup: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactApi();
$cardId = cardId_example; // String | specified card id
$groupId = groupId_example; // String | specified group id

try {
    $result = $api_instance->setCardGroup($cardId, $groupId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactApi->setCardGroup: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactApi;


my $api_instance = WWW::SwaggerClient::ContactApi->new();
my $cardId = cardId_example; # String | specified card id
my $groupId = groupId_example; # String | specified group id

eval { 
    my $result = $api_instance->setCardGroup(cardId => $cardId, groupId => $groupId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactApi->setCardGroup: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContactApi()
cardId = cardId_example # String | specified card id
groupId = groupId_example # String | specified group id

try: 
    api_response = api_instance.set_card_group(cardId, groupId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactApi->setCardGroup: %s\n" % e)

Parameters

Path parameters

Name	Description
cardId*	String specified card id Required
groupId*	String specified group id Required

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 404 - card or group not found

Status: 500 - internal server error

setCardNotes

Update card notes for specified card. Access granted to app tokens for account holder.

/contact/cards/{cardId}/notes

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//contact/cards/{cardId}/notes"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactApi;

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

public class ContactApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContactApi apiInstance = new ContactApi();
        String cardId = cardId_example; // String | specified card id
        String body = ; // String | 
        try {
            CardData result = apiInstance.setCardNotes(cardId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#setCardNotes");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContactApi;

public class ContactApiExample {

    public static void main(String[] args) {
        ContactApi apiInstance = new ContactApi();
        String cardId = cardId_example; // String | specified card id
        String body = ; // String | 
        try {
            CardData result = apiInstance.setCardNotes(cardId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#setCardNotes");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *cardId = cardId_example; // specified card id
String *body = ; //  (optional)

ContactApi *apiInstance = [[ContactApi alloc] init];

[apiInstance setCardNotesWith:cardId
    body:body
              completionHandler: ^(CardData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContactApi()
var cardId = cardId_example; // {{String}} specified card id
var opts = { 
  'body':  // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setCardNotes(cardId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactApi();
            var cardId = cardId_example;  // String | specified card id
            var body = new String(); // String |  (optional) 

            try
            {
                CardData result = apiInstance.setCardNotes(cardId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.setCardNotes: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactApi();
$cardId = cardId_example; // String | specified card id
$body = ; // String | 

try {
    $result = $api_instance->setCardNotes($cardId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactApi->setCardNotes: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactApi;


my $api_instance = WWW::SwaggerClient::ContactApi->new();
my $cardId = cardId_example; # String | specified card id
my $body = WWW::SwaggerClient::Object::String->new(); # String | 

eval { 
    my $result = $api_instance->setCardNotes(cardId => $cardId, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactApi->setCardNotes: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContactApi()
cardId = cardId_example # String | specified card id
body =  # String |  (optional)

try: 
    api_response = api_instance.set_card_notes(cardId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactApi->setCardNotes: %s\n" % e)

Parameters

Path parameters

Name	Description
cardId*	String specified card id Required

Body parameters

Name	Description
body

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 404 - card not found

Status: 500 - internal server error

setCardProfile

Set profile of card entry. Access granted to app tokens of account holder.

/contact/cards/{cardId}/profile

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//contact/cards/{cardId}/profile"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactApi;

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

public class ContactApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContactApi apiInstance = new ContactApi();
        String cardId = cardId_example; // String | specified card id
        Profile body = ; // Profile | 
        try {
            DataMessage result = apiInstance.setCardProfile(cardId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#setCardProfile");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContactApi;

public class ContactApiExample {

    public static void main(String[] args) {
        ContactApi apiInstance = new ContactApi();
        String cardId = cardId_example; // String | specified card id
        Profile body = ; // Profile | 
        try {
            DataMessage result = apiInstance.setCardProfile(cardId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#setCardProfile");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *cardId = cardId_example; // specified card id
Profile *body = ; //  (optional)

ContactApi *apiInstance = [[ContactApi alloc] init];

[apiInstance setCardProfileWith:cardId
    body:body
              completionHandler: ^(DataMessage output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContactApi()
var cardId = cardId_example; // {{String}} specified card id
var opts = { 
  'body':  // {{Profile}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setCardProfile(cardId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactApi();
            var cardId = cardId_example;  // String | specified card id
            var body = new Profile(); // Profile |  (optional) 

            try
            {
                DataMessage result = apiInstance.setCardProfile(cardId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.setCardProfile: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactApi();
$cardId = cardId_example; // String | specified card id
$body = ; // Profile | 

try {
    $result = $api_instance->setCardProfile($cardId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactApi->setCardProfile: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactApi;


my $api_instance = WWW::SwaggerClient::ContactApi->new();
my $cardId = cardId_example; # String | specified card id
my $body = WWW::SwaggerClient::Object::Profile->new(); # Profile | 

eval { 
    my $result = $api_instance->setCardProfile(cardId => $cardId, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactApi->setCardProfile: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContactApi()
cardId = cardId_example # String | specified card id
body =  # Profile |  (optional)

try: 
    api_response = api_instance.set_card_profile(cardId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactApi->setCardProfile: %s\n" % e)

Parameters

Path parameters

Name	Description
cardId*	String specified card id Required

Body parameters

Name	Description
body

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 404 - card not found

Status: 500 - internal server error

setCardStatus

Updated connected status of contact. Access granted to app tokens of account holder.

/contact/cards/{cardId}/status

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//contact/cards/{cardId}/status?token="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactApi;

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

public class ContactApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContactApi apiInstance = new ContactApi();
        String cardId = cardId_example; // String | specified card id
        String body = ; // String | 
        String token = token_example; // String | token for accessing card
        try {
            CardData result = apiInstance.setCardStatus(cardId, body, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#setCardStatus");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContactApi;

public class ContactApiExample {

    public static void main(String[] args) {
        ContactApi apiInstance = new ContactApi();
        String cardId = cardId_example; // String | specified card id
        String body = ; // String | 
        String token = token_example; // String | token for accessing card
        try {
            CardData result = apiInstance.setCardStatus(cardId, body, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#setCardStatus");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *cardId = cardId_example; // specified card id
String *body = ; //  (optional)
String *token = token_example; // token for accessing card (optional)

ContactApi *apiInstance = [[ContactApi alloc] init];

[apiInstance setCardStatusWith:cardId
    body:body
    token:token
              completionHandler: ^(CardData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContactApi()
var cardId = cardId_example; // {{String}} specified card id
var opts = { 
  'body':  // {{String}} 
  'token': token_example // {{String}} token for accessing card
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setCardStatus(cardId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactApi();
            var cardId = cardId_example;  // String | specified card id
            var body = new String(); // String |  (optional) 
            var token = token_example;  // String | token for accessing card (optional) 

            try
            {
                CardData result = apiInstance.setCardStatus(cardId, body, token);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.setCardStatus: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactApi();
$cardId = cardId_example; // String | specified card id
$body = ; // String | 
$token = token_example; // String | token for accessing card

try {
    $result = $api_instance->setCardStatus($cardId, $body, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactApi->setCardStatus: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactApi;


my $api_instance = WWW::SwaggerClient::ContactApi->new();
my $cardId = cardId_example; # String | specified card id
my $body = WWW::SwaggerClient::Object::String->new(); # String | 
my $token = token_example; # String | token for accessing card

eval { 
    my $result = $api_instance->setCardStatus(cardId => $cardId, body => $body, token => $token);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactApi->setCardStatus: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContactApi()
cardId = cardId_example # String | specified card id
body =  # String |  (optional)
token = token_example # String | token for accessing card (optional)

try: 
    api_response = api_instance.set_card_status(cardId, body=body, token=token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactApi->setCardStatus: %s\n" % e)

Parameters

Path parameters

Name	Description
cardId*	String specified card id Required

Body parameters

Name	Description
body

Query parameters

Name	Description
token	String token for accessing card

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 404 - card not found

Status: 500 - internal server error

setCloseMessage

Set message for closing card connection. Access granted to public.

/contact/closeMessage

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//contact/closeMessage"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactApi;

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

public class ContactApiExample {

    public static void main(String[] args) {
        
        ContactApi apiInstance = new ContactApi();
        DataMessage body = ; // DataMessage | 
        try {
            inline_response_200 result = apiInstance.setCloseMessage(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#setCloseMessage");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContactApi;

public class ContactApiExample {

    public static void main(String[] args) {
        ContactApi apiInstance = new ContactApi();
        DataMessage body = ; // DataMessage | 
        try {
            inline_response_200 result = apiInstance.setCloseMessage(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#setCloseMessage");
            e.printStackTrace();
        }
    }
}

DataMessage *body = ; //  (optional)

ContactApi *apiInstance = [[ContactApi alloc] init];

[apiInstance setCloseMessageWith:body
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');

var api = new DataBag.ContactApi()
var opts = { 
  'body':  // {{DataMessage}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setCloseMessage(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ContactApi();
            var body = new DataMessage(); // DataMessage |  (optional) 

            try
            {
                inline_response_200 result = apiInstance.setCloseMessage(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.setCloseMessage: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiContactApi();
$body = ; // DataMessage | 

try {
    $result = $api_instance->setCloseMessage($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactApi->setCloseMessage: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactApi;

my $api_instance = WWW::SwaggerClient::ContactApi->new();
my $body = WWW::SwaggerClient::Object::DataMessage->new(); # DataMessage | 

eval { 
    my $result = $api_instance->setCloseMessage(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactApi->setCloseMessage: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ContactApi()
body =  # DataMessage |  (optional)

try: 
    api_response = api_instance.set_close_message(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactApi->setCloseMessage: %s\n" % e)

Parameters

Body parameters

Name	Description
body

Responses

Status: 200 - successful operation

Schema

Status: 400 - invalid data message

Status: 500 - internal server error

setContentRevision

Set content revision for contact. This is intend to be invoked automatically anytime a contact updates their content or sharing. Access granted to contact tokens.

/contact/content/revision

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Content-Type: application/json"\
"//contact/content/revision"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactApi;

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

public class ContactApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContactApi apiInstance = new ContactApi();
        Long body = ; // Long | 
        try {
            apiInstance.setContentRevision(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#setContentRevision");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContactApi;

public class ContactApiExample {

    public static void main(String[] args) {
        ContactApi apiInstance = new ContactApi();
        Long body = ; // Long | 
        try {
            apiInstance.setContentRevision(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#setContentRevision");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
Long *body = ; //  (optional)

ContactApi *apiInstance = [[ContactApi alloc] init];

[apiInstance setContentRevisionWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContactApi()
var opts = { 
  'body':  // {{Long}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setContentRevision(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactApi();
            var body = new Long(); // Long |  (optional) 

            try
            {
                apiInstance.setContentRevision(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.setContentRevision: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactApi();
$body = ; // Long | 

try {
    $api_instance->setContentRevision($body);
} catch (Exception $e) {
    echo 'Exception when calling ContactApi->setContentRevision: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactApi;


my $api_instance = WWW::SwaggerClient::ContactApi->new();
my $body = WWW::SwaggerClient::Object::Long->new(); # Long | 

eval { 
    $api_instance->setContentRevision(body => $body);
};
if ($@) {
    warn "Exception when calling ContactApi->setContentRevision: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContactApi()
body =  # Long |  (optional)

try: 
    api_instance.set_content_revision(body=body)
except ApiException as e:
    print("Exception when calling ContactApi->setContentRevision: %s\n" % e)

Parameters

Body parameters

Name	Description
body

Responses

Status: 200 - revision set

Status: 401 - not authorized

Status: 500 - internal server error

setOpenMessage

Set message for connecting to a contact. If card has not already been added, the card will be created in the pending state. Access granted to public.

/contact/openMessage

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//contact/openMessage"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactApi;

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

public class ContactApiExample {

    public static void main(String[] args) {
        
        ContactApi apiInstance = new ContactApi();
        DataMessage body = ; // DataMessage | 
        try {
            inline_response_200 result = apiInstance.setOpenMessage(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#setOpenMessage");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContactApi;

public class ContactApiExample {

    public static void main(String[] args) {
        ContactApi apiInstance = new ContactApi();
        DataMessage body = ; // DataMessage | 
        try {
            inline_response_200 result = apiInstance.setOpenMessage(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#setOpenMessage");
            e.printStackTrace();
        }
    }
}

DataMessage *body = ; //  (optional)

ContactApi *apiInstance = [[ContactApi alloc] init];

[apiInstance setOpenMessageWith:body
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');

var api = new DataBag.ContactApi()
var opts = { 
  'body':  // {{DataMessage}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setOpenMessage(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ContactApi();
            var body = new DataMessage(); // DataMessage |  (optional) 

            try
            {
                inline_response_200 result = apiInstance.setOpenMessage(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.setOpenMessage: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiContactApi();
$body = ; // DataMessage | 

try {
    $result = $api_instance->setOpenMessage($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactApi->setOpenMessage: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactApi;

my $api_instance = WWW::SwaggerClient::ContactApi->new();
my $body = WWW::SwaggerClient::Object::DataMessage->new(); # DataMessage | 

eval { 
    my $result = $api_instance->setOpenMessage(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactApi->setOpenMessage: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ContactApi()
body =  # DataMessage |  (optional)

try: 
    api_response = api_instance.set_open_message(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactApi->setOpenMessage: %s\n" % e)

Parameters

Body parameters

Name	Description
body

Responses

Status: 200 - successful operation

Schema

Status: 400 - invalid data message

Status: 500 - internal server error

setProfileRevision

Set profile revision for contact. This is intend to be invoked automatically anytime a contact updates their profile. Access granted to contact tokens.

/contact/profile/revision

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Content-Type: application/json"\
"//contact/profile/revision"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactApi;

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

public class ContactApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContactApi apiInstance = new ContactApi();
        Long body = ; // Long | 
        try {
            apiInstance.setProfileRevision(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#setProfileRevision");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContactApi;

public class ContactApiExample {

    public static void main(String[] args) {
        ContactApi apiInstance = new ContactApi();
        Long body = ; // Long | 
        try {
            apiInstance.setProfileRevision(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#setProfileRevision");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
Long *body = ; //  (optional)

ContactApi *apiInstance = [[ContactApi alloc] init];

[apiInstance setProfileRevisionWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContactApi()
var opts = { 
  'body':  // {{Long}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setProfileRevision(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactApi();
            var body = new Long(); // Long |  (optional) 

            try
            {
                apiInstance.setProfileRevision(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.setProfileRevision: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactApi();
$body = ; // Long | 

try {
    $api_instance->setProfileRevision($body);
} catch (Exception $e) {
    echo 'Exception when calling ContactApi->setProfileRevision: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactApi;


my $api_instance = WWW::SwaggerClient::ContactApi->new();
my $body = WWW::SwaggerClient::Object::Long->new(); # Long | 

eval { 
    $api_instance->setProfileRevision(body => $body);
};
if ($@) {
    warn "Exception when calling ContactApi->setProfileRevision: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContactApi()
body =  # Long |  (optional)

try: 
    api_instance.set_profile_revision(body=body)
except ApiException as e:
    print("Exception when calling ContactApi->setProfileRevision: %s\n" % e)

Parameters

Body parameters

Name	Description
body

Responses

Status: 200 - revision set

Status: 401 - not authorized

Status: 500 - internal server error

Content

addArticle

Add a content article. Access granted to app token of the account holder.

/content/articles

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//content/articles"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        Content_articles_body body = ; // Content_articles_body | 
        try {
            inline_response_201 result = apiInstance.addArticle(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#addArticle");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        Content_articles_body body = ; // Content_articles_body | 
        try {
            inline_response_201 result = apiInstance.addArticle(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#addArticle");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
Content_articles_body *body = ; //  (optional)

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance addArticleWith:body
              completionHandler: ^(inline_response_201 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var opts = { 
  'body':  // {{Content_articles_body}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addArticle(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();
            var body = new Content_articles_body(); // Content_articles_body |  (optional) 

            try
            {
                inline_response_201 result = apiInstance.addArticle(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.addArticle: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();
$body = ; // Content_articles_body | 

try {
    $result = $api_instance->addArticle($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->addArticle: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();
my $body = WWW::SwaggerClient::Object::Content_articles_body->new(); # Content_articles_body | 

eval { 
    my $result = $api_instance->addArticle(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->addArticle: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()
body =  # Content_articles_body |  (optional)

try: 
    api_response = api_instance.add_article(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->addArticle: %s\n" % e)

Parameters

Body parameters

Name	Description
body

Responses

Status: 201 - entry created

Schema

Status: 401 - permission denied

Status: 500 - internal server error

addArticleAsset

Add an an asset to the to an article. The original posted asset is referenced in the asset list with a null transform. The transformed assets are referenced accordingly. Transforming the asset strips it of metadata and transcodes it into a specified format. Access is granted to the app token of the account holder.

/content/articles/{articleId}/assets

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: multipart/form-data"\
"//content/articles/{articleId}/assets?transforms="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        byte[] fileName = fileName_example; // byte[] | 
        array[String] transforms = ; // array[String] | transforms to apply
        try {
            Asset result = apiInstance.addArticleAsset(articleId, fileName, transforms);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#addArticleAsset");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        byte[] fileName = fileName_example; // byte[] | 
        array[String] transforms = ; // array[String] | transforms to apply
        try {
            Asset result = apiInstance.addArticleAsset(articleId, fileName, transforms);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#addArticleAsset");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *articleId = articleId_example; // specified article id
byte[] *fileName = fileName_example; //  (optional)
array[String] *transforms = ; // transforms to apply (optional)

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance addArticleAssetWith:articleId
    fileName:fileName
    transforms:transforms
              completionHandler: ^(Asset output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var articleId = articleId_example; // {{String}} specified article id
var opts = { 
  'fileName': fileName_example // {{byte[]}} 
  'transforms':  // {{array[String]}} transforms to apply
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addArticleAsset(articleId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();
            var articleId = articleId_example;  // String | specified article id
            var fileName = fileName_example;  // byte[] |  (optional) 
            var transforms = new array[String](); // array[String] | transforms to apply (optional) 

            try
            {
                Asset result = apiInstance.addArticleAsset(articleId, fileName, transforms);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.addArticleAsset: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();
$articleId = articleId_example; // String | specified article id
$fileName = fileName_example; // byte[] | 
$transforms = ; // array[String] | transforms to apply

try {
    $result = $api_instance->addArticleAsset($articleId, $fileName, $transforms);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->addArticleAsset: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();
my $articleId = articleId_example; # String | specified article id
my $fileName = fileName_example; # byte[] | 
my $transforms = []; # array[String] | transforms to apply

eval { 
    my $result = $api_instance->addArticleAsset(articleId => $articleId, fileName => $fileName, transforms => $transforms);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->addArticleAsset: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()
articleId = articleId_example # String | specified article id
fileName = fileName_example # byte[] |  (optional)
transforms =  # array[String] | transforms to apply (optional)

try: 
    api_response = api_instance.add_article_asset(articleId, fileName=fileName, transforms=transforms)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->addArticleAsset: %s\n" % e)

Parameters

Path parameters

Name	Description
articleId*	String specified article id Required

Form parameters

Name	Description
fileName	byte[] (binary)

Query parameters

Name	Description
transforms	array[String] transforms to apply

Responses

Status: 201 - success

Schema

Status: 401 - permission denied

Status: 404 - article not found

Status: 406 - storage limit reached

Status: 500 - internal server error

addArticleTag

Add a tag to an article. Access granted to app tokens of the account holder and contact tokens of accounts with which the article is shared.

/content/articles/{articleId}/tags

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//content/articles/{articleId}/tags"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        try {
            inline_response_200_2 result = apiInstance.addArticleTag(articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#addArticleTag");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        try {
            inline_response_200_2 result = apiInstance.addArticleTag(articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#addArticleTag");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *articleId = articleId_example; // specified article id

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance addArticleTagWith:articleId
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var articleId = articleId_example; // {{String}} specified article id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addArticleTag(articleId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();
            var articleId = articleId_example;  // String | specified article id

            try
            {
                inline_response_200_2 result = apiInstance.addArticleTag(articleId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.addArticleTag: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();
$articleId = articleId_example; // String | specified article id

try {
    $result = $api_instance->addArticleTag($articleId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->addArticleTag: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();
my $articleId = articleId_example; # String | specified article id

eval { 
    my $result = $api_instance->addArticleTag(articleId => $articleId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->addArticleTag: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()
articleId = articleId_example # String | specified article id

try: 
    api_response = api_instance.add_article_tag(articleId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->addArticleTag: %s\n" % e)

Parameters

Path parameters

Name	Description
articleId*	String specified article id Required

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 404 - article not found

Status: 500 - internal server error

addLabel

Add a new label for organizing the articles. Access granted to the app tokens of the account holder.

/content/labels

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Content-Type: application/json"\
"//content/labels"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        Content_labels_body body = ; // Content_labels_body | 
        try {
            apiInstance.addLabel(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#addLabel");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        Content_labels_body body = ; // Content_labels_body | 
        try {
            apiInstance.addLabel(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#addLabel");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
Content_labels_body *body = ; //  (optional)

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance addLabelWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var opts = { 
  'body':  // {{Content_labels_body}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addLabel(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();
            var body = new Content_labels_body(); // Content_labels_body |  (optional) 

            try
            {
                apiInstance.addLabel(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.addLabel: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();
$body = ; // Content_labels_body | 

try {
    $api_instance->addLabel($body);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->addLabel: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();
my $body = WWW::SwaggerClient::Object::Content_labels_body->new(); # Content_labels_body | 

eval { 
    $api_instance->addLabel(body => $body);
};
if ($@) {
    warn "Exception when calling ContentApi->addLabel: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()
body =  # Content_labels_body |  (optional)

try: 
    api_instance.add_label(body=body)
except ApiException as e:
    print("Exception when calling ContentApi->addLabel: %s\n" % e)

Parameters

Body parameters

Name	Description
body

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 500 - internal server error

clearArticleGroup

Remove article from sharing group. Unless the article is shared through other groups or labels contacts within that group will no longer have access to the article. Access granted to app tokens of the account holder.

/content/articles/{articleId}/groups/{groupId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
"//content/articles/{articleId}/groups/{groupId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        String groupId = groupId_example; // String | specified share id
        try {
            apiInstance.clearArticleGroup(articleId, groupId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#clearArticleGroup");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        String groupId = groupId_example; // String | specified share id
        try {
            apiInstance.clearArticleGroup(articleId, groupId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#clearArticleGroup");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *articleId = articleId_example; // specified article id
String *groupId = groupId_example; // specified share id

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance clearArticleGroupWith:articleId
    groupId:groupId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var articleId = articleId_example; // {{String}} specified article id
var groupId = groupId_example; // {{String}} specified share id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.clearArticleGroup(articleId, groupId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();
            var articleId = articleId_example;  // String | specified article id
            var groupId = groupId_example;  // String | specified share id

            try
            {
                apiInstance.clearArticleGroup(articleId, groupId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.clearArticleGroup: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();
$articleId = articleId_example; // String | specified article id
$groupId = groupId_example; // String | specified share id

try {
    $api_instance->clearArticleGroup($articleId, $groupId);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->clearArticleGroup: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();
my $articleId = articleId_example; # String | specified article id
my $groupId = groupId_example; # String | specified share id

eval { 
    $api_instance->clearArticleGroup(articleId => $articleId, groupId => $groupId);
};
if ($@) {
    warn "Exception when calling ContentApi->clearArticleGroup: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()
articleId = articleId_example # String | specified article id
groupId = groupId_example # String | specified share id

try: 
    api_instance.clear_article_group(articleId, groupId)
except ApiException as e:
    print("Exception when calling ContentApi->clearArticleGroup: %s\n" % e)

Parameters

Path parameters

Name	Description
articleId*	String specified article id Required
groupId*	String specified share id Required

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 404 - group or article not found

Status: 500 - internal server error

clearArticleLabel

Remove a label from an article. If the label has been assigned a sharing group the article and the article is not shared in another way, the article will no longer be accessible to that group's contacts. Access is granted to app tokens of the account holder.

/content/articles/{articleId}/labels/{labelId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
"//content/articles/{articleId}/labels/{labelId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        String labelId = labelId_example; // String | specified label id
        try {
            apiInstance.clearArticleLabel(articleId, labelId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#clearArticleLabel");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        String labelId = labelId_example; // String | specified label id
        try {
            apiInstance.clearArticleLabel(articleId, labelId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#clearArticleLabel");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *articleId = articleId_example; // specified article id
String *labelId = labelId_example; // specified label id

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance clearArticleLabelWith:articleId
    labelId:labelId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var articleId = articleId_example; // {{String}} specified article id
var labelId = labelId_example; // {{String}} specified label id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.clearArticleLabel(articleId, labelId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();
            var articleId = articleId_example;  // String | specified article id
            var labelId = labelId_example;  // String | specified label id

            try
            {
                apiInstance.clearArticleLabel(articleId, labelId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.clearArticleLabel: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();
$articleId = articleId_example; // String | specified article id
$labelId = labelId_example; // String | specified label id

try {
    $api_instance->clearArticleLabel($articleId, $labelId);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->clearArticleLabel: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();
my $articleId = articleId_example; # String | specified article id
my $labelId = labelId_example; # String | specified label id

eval { 
    $api_instance->clearArticleLabel(articleId => $articleId, labelId => $labelId);
};
if ($@) {
    warn "Exception when calling ContentApi->clearArticleLabel: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()
articleId = articleId_example # String | specified article id
labelId = labelId_example # String | specified label id

try: 
    api_instance.clear_article_label(articleId, labelId)
except ApiException as e:
    print("Exception when calling ContentApi->clearArticleLabel: %s\n" % e)

Parameters

Path parameters

Name	Description
articleId*	String specified article id Required
labelId*	String specified label id Required

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 404 - label or article not found

Status: 500 - internal server error

clearLabelGroup

Clear a sharing group from a label. Access granted to app tokens of the account holder.

/content/labels/{labelId}/groups/{groupId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
"//content/labels/{labelId}/groups/{groupId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        String labelId = labelId_example; // String | specified label id
        String groupId = groupId_example; // String | specified group id
        try {
            apiInstance.clearLabelGroup(labelId, groupId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#clearLabelGroup");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String labelId = labelId_example; // String | specified label id
        String groupId = groupId_example; // String | specified group id
        try {
            apiInstance.clearLabelGroup(labelId, groupId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#clearLabelGroup");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *labelId = labelId_example; // specified label id
String *groupId = groupId_example; // specified group id

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance clearLabelGroupWith:labelId
    groupId:groupId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var labelId = labelId_example; // {{String}} specified label id
var groupId = groupId_example; // {{String}} specified group id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.clearLabelGroup(labelId, groupId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();
            var labelId = labelId_example;  // String | specified label id
            var groupId = groupId_example;  // String | specified group id

            try
            {
                apiInstance.clearLabelGroup(labelId, groupId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.clearLabelGroup: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();
$labelId = labelId_example; // String | specified label id
$groupId = groupId_example; // String | specified group id

try {
    $api_instance->clearLabelGroup($labelId, $groupId);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->clearLabelGroup: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();
my $labelId = labelId_example; # String | specified label id
my $groupId = groupId_example; # String | specified group id

eval { 
    $api_instance->clearLabelGroup(labelId => $labelId, groupId => $groupId);
};
if ($@) {
    warn "Exception when calling ContentApi->clearLabelGroup: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()
labelId = labelId_example # String | specified label id
groupId = groupId_example # String | specified group id

try: 
    api_instance.clear_label_group(labelId, groupId)
except ApiException as e:
    print("Exception when calling ContentApi->clearLabelGroup: %s\n" % e)

Parameters

Path parameters

Name	Description
labelId*	String specified label id Required
groupId*	String specified group id Required

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 404 - group or label not found

Status: 500 - internal server error

getArticle

Get specified article. Access granted to app token of account holder or contact token of account the article is shared with.

/content/articles/{articleId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//content/articles/{articleId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        try {
            Article result = apiInstance.getArticle(articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getArticle");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        try {
            Article result = apiInstance.getArticle(articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getArticle");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *articleId = articleId_example; // specified article id

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance getArticleWith:articleId
              completionHandler: ^(Article output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var articleId = articleId_example; // {{String}} specified article id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getArticle(articleId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();
            var articleId = articleId_example;  // String | specified article id

            try
            {
                Article result = apiInstance.getArticle(articleId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.getArticle: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();
$articleId = articleId_example; // String | specified article id

try {
    $result = $api_instance->getArticle($articleId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->getArticle: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();
my $articleId = articleId_example; # String | specified article id

eval { 
    my $result = $api_instance->getArticle(articleId => $articleId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->getArticle: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()
articleId = articleId_example # String | specified article id

try: 
    api_response = api_instance.get_article(articleId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->getArticle: %s\n" % e)

Parameters

Path parameters

Name	Description
articleId*	String specified article id Required

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 404 - article not found

Status: 500 - internal server error

getArticleAsset

Get asset assigned to an article. The endpoint supports byte-range requests and responds with the content-type set appropriatly. Access granted to the app tokens of the account holder and in the case of non-original assets, the contact token for accounts with which the article is shared.

/content/articles/{articleId}/assets/{assetId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/octet-stream"\
"//content/articles/{articleId}/assets/{assetId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        String assetId = assetId_example; // String | specified asset id
        try {
            byte[] result = apiInstance.getArticleAsset(articleId, assetId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getArticleAsset");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        String assetId = assetId_example; // String | specified asset id
        try {
            byte[] result = apiInstance.getArticleAsset(articleId, assetId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getArticleAsset");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *articleId = articleId_example; // specified article id
String *assetId = assetId_example; // specified asset id

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance getArticleAssetWith:articleId
    assetId:assetId
              completionHandler: ^(byte[] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var articleId = articleId_example; // {{String}} specified article id
var assetId = assetId_example; // {{String}} specified asset id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getArticleAsset(articleId, assetId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();
            var articleId = articleId_example;  // String | specified article id
            var assetId = assetId_example;  // String | specified asset id

            try
            {
                byte[] result = apiInstance.getArticleAsset(articleId, assetId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.getArticleAsset: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();
$articleId = articleId_example; // String | specified article id
$assetId = assetId_example; // String | specified asset id

try {
    $result = $api_instance->getArticleAsset($articleId, $assetId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->getArticleAsset: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();
my $articleId = articleId_example; # String | specified article id
my $assetId = assetId_example; # String | specified asset id

eval { 
    my $result = $api_instance->getArticleAsset(articleId => $articleId, assetId => $assetId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->getArticleAsset: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()
articleId = articleId_example # String | specified article id
assetId = assetId_example # String | specified asset id

try: 
    api_response = api_instance.get_article_asset(articleId, assetId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->getArticleAsset: %s\n" % e)

Parameters

Path parameters

Name	Description
articleId*	String specified article id Required
assetId*	String specified asset id Required

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 404 - asset or article not found

Status: 500 - internal server error

getArticleAssets

Get list of assets assigned to an article. The original assets will only be available to the account holder to provent the accidental sharing of content metadata. Access is granted to the app token of the account holder and the contact token of accounts the article has been shared with.

/content/articles/{articleId}/assets

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//content/articles/{articleId}/assets"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        try {
            array[Asset] result = apiInstance.getArticleAssets(articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getArticleAssets");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        try {
            array[Asset] result = apiInstance.getArticleAssets(articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getArticleAssets");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *articleId = articleId_example; // specified article id

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance getArticleAssetsWith:articleId
              completionHandler: ^(array[Asset] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var articleId = articleId_example; // {{String}} specified article id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getArticleAssets(articleId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();
            var articleId = articleId_example;  // String | specified article id

            try
            {
                array[Asset] result = apiInstance.getArticleAssets(articleId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.getArticleAssets: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();
$articleId = articleId_example; // String | specified article id

try {
    $result = $api_instance->getArticleAssets($articleId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->getArticleAssets: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();
my $articleId = articleId_example; # String | specified article id

eval { 
    my $result = $api_instance->getArticleAssets(articleId => $articleId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->getArticleAssets: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()
articleId = articleId_example # String | specified article id

try: 
    api_response = api_instance.get_article_assets(articleId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->getArticleAssets: %s\n" % e)

Parameters

Path parameters

Name	Description
articleId*	String specified article id Required

Responses

Status: 201 - entry created

Schema

Status: 401 - invalid token

Status: 500 - internal server error

getArticleBlockView

Get article block views. Acess granted to account token or contact token. When the request is made with a contact token the account view revision will be added to the block revision.

/content/articleBlocks/view

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//content/articleBlocks/view"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        try {
            array[inline_response_200_1] result = apiInstance.getArticleBlockView();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getArticleBlockView");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        try {
            array[inline_response_200_1] result = apiInstance.getArticleBlockView();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getArticleBlockView");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance getArticleBlockViewWithCompletionHandler: 
              ^(array[inline_response_200_1] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getArticleBlockView(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();

            try
            {
                array[inline_response_200_1] result = apiInstance.getArticleBlockView();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.getArticleBlockView: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();

try {
    $result = $api_instance->getArticleBlockView();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->getArticleBlockView: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();

eval { 
    my $result = $api_instance->getArticleBlockView();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->getArticleBlockView: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()

try: 
    api_response = api_instance.get_article_block_view()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->getArticleBlockView: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation

Schema

Status: 401 - permission denied

Status: 500 - internal server error

getArticleSubjectField

Base64 decode and download specified field from the article's subject. Access granted to app token of account holder or contact token of account the article is shared with.

/content/articles/{articleId}/subject/{field}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//content/articles/{articleId}/subject/{field}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        String field = field_example; // String | field from subject to base64 decode and download
        try {
            Article result = apiInstance.getArticleSubjectField(articleId, field);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getArticleSubjectField");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        String field = field_example; // String | field from subject to base64 decode and download
        try {
            Article result = apiInstance.getArticleSubjectField(articleId, field);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getArticleSubjectField");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *articleId = articleId_example; // specified article id
String *field = field_example; // field from subject to base64 decode and download

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance getArticleSubjectFieldWith:articleId
    field:field
              completionHandler: ^(Article output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var articleId = articleId_example; // {{String}} specified article id
var field = field_example; // {{String}} field from subject to base64 decode and download

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getArticleSubjectField(articleId, field, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();
            var articleId = articleId_example;  // String | specified article id
            var field = field_example;  // String | field from subject to base64 decode and download

            try
            {
                Article result = apiInstance.getArticleSubjectField(articleId, field);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.getArticleSubjectField: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();
$articleId = articleId_example; // String | specified article id
$field = field_example; // String | field from subject to base64 decode and download

try {
    $result = $api_instance->getArticleSubjectField($articleId, $field);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->getArticleSubjectField: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();
my $articleId = articleId_example; # String | specified article id
my $field = field_example; # String | field from subject to base64 decode and download

eval { 
    my $result = $api_instance->getArticleSubjectField(articleId => $articleId, field => $field);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->getArticleSubjectField: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()
articleId = articleId_example # String | specified article id
field = field_example # String | field from subject to base64 decode and download

try: 
    api_response = api_instance.get_article_subject_field(articleId, field)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->getArticleSubjectField: %s\n" % e)

Parameters

Path parameters

Name	Description
articleId*	String specified article id Required
field*	String field from subject to base64 decode and download Required

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 404 - field, article not found

Status: 405 - invalid field

Status: 500 - internal server error

getArticleTag

Get specified tag. Access granted to app tokens of account holder and contact tokens of accounts with which the article is shared.

/content/articles/{articleId}/tags/{tagId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//content/articles/{articleId}/tags/{tagId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        String tagId = tagId_example; // String | specified tag id
        try {
            Tag result = apiInstance.getArticleTag(articleId, tagId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getArticleTag");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        String tagId = tagId_example; // String | specified tag id
        try {
            Tag result = apiInstance.getArticleTag(articleId, tagId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getArticleTag");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *articleId = articleId_example; // specified article id
String *tagId = tagId_example; // specified tag id

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance getArticleTagWith:articleId
    tagId:tagId
              completionHandler: ^(Tag output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var articleId = articleId_example; // {{String}} specified article id
var tagId = tagId_example; // {{String}} specified tag id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getArticleTag(articleId, tagId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();
            var articleId = articleId_example;  // String | specified article id
            var tagId = tagId_example;  // String | specified tag id

            try
            {
                Tag result = apiInstance.getArticleTag(articleId, tagId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.getArticleTag: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();
$articleId = articleId_example; // String | specified article id
$tagId = tagId_example; // String | specified tag id

try {
    $result = $api_instance->getArticleTag($articleId, $tagId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->getArticleTag: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();
my $articleId = articleId_example; # String | specified article id
my $tagId = tagId_example; # String | specified tag id

eval { 
    my $result = $api_instance->getArticleTag(articleId => $articleId, tagId => $tagId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->getArticleTag: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()
articleId = articleId_example # String | specified article id
tagId = tagId_example # String | specified tag id

try: 
    api_response = api_instance.get_article_tag(articleId, tagId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->getArticleTag: %s\n" % e)

Parameters

Path parameters

Name	Description
articleId*	String specified article id Required
tagId*	String specified tag id Required

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 404 - tag or article not found

Status: 500 - internal server error

getArticleTagBlockView

Get view of tag blocks associated with specified article. Access granted to app tokens of account holder and contact tokens of account with which the article is shared.

/content/articles/{articleId}/tagBlocks/view

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//content/articles/{articleId}/tagBlocks/view?types="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        array[String] types = ; // array[String] | limit results to tags of types
        try {
            array[inline_response_200_1] result = apiInstance.getArticleTagBlockView(articleId, types);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getArticleTagBlockView");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        array[String] types = ; // array[String] | limit results to tags of types
        try {
            array[inline_response_200_1] result = apiInstance.getArticleTagBlockView(articleId, types);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getArticleTagBlockView");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *articleId = articleId_example; // specified article id
array[String] *types = ; // limit results to tags of types (optional)

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance getArticleTagBlockViewWith:articleId
    types:types
              completionHandler: ^(array[inline_response_200_1] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var articleId = articleId_example; // {{String}} specified article id
var opts = { 
  'types':  // {{array[String]}} limit results to tags of types
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getArticleTagBlockView(articleId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();
            var articleId = articleId_example;  // String | specified article id
            var types = new array[String](); // array[String] | limit results to tags of types (optional) 

            try
            {
                array[inline_response_200_1] result = apiInstance.getArticleTagBlockView(articleId, types);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.getArticleTagBlockView: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();
$articleId = articleId_example; // String | specified article id
$types = ; // array[String] | limit results to tags of types

try {
    $result = $api_instance->getArticleTagBlockView($articleId, $types);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->getArticleTagBlockView: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();
my $articleId = articleId_example; # String | specified article id
my $types = []; # array[String] | limit results to tags of types

eval { 
    my $result = $api_instance->getArticleTagBlockView(articleId => $articleId, types => $types);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->getArticleTagBlockView: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()
articleId = articleId_example # String | specified article id
types =  # array[String] | limit results to tags of types (optional)

try: 
    api_response = api_instance.get_article_tag_block_view(articleId, types=types)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->getArticleTagBlockView: %s\n" % e)

Parameters

Path parameters

Name	Description
articleId*	String specified article id Required

Query parameters

Name	Description
types	array[String] limit results to tags of types

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 404 - article not found

Status: 500 - internal server error

getArticleTagSubjectField

Base64 decode and retrieve specified tag on the article. Access granted to app tokens of account holder and contact tokens of accounts with which the article is shared.

/content/articles/{articleId}/tags/{tagId}/subject/{field}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//content/articles/{articleId}/tags/{tagId}/subject/{field}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        String tagId = tagId_example; // String | specified tag id
        String field = field_example; // String | field to base64 decode and transfer
        try {
            Tag result = apiInstance.getArticleTagSubjectField(articleId, tagId, field);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getArticleTagSubjectField");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        String tagId = tagId_example; // String | specified tag id
        String field = field_example; // String | field to base64 decode and transfer
        try {
            Tag result = apiInstance.getArticleTagSubjectField(articleId, tagId, field);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getArticleTagSubjectField");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *articleId = articleId_example; // specified article id
String *tagId = tagId_example; // specified tag id
String *field = field_example; // field to base64 decode and transfer

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance getArticleTagSubjectFieldWith:articleId
    tagId:tagId
    field:field
              completionHandler: ^(Tag output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var articleId = articleId_example; // {{String}} specified article id
var tagId = tagId_example; // {{String}} specified tag id
var field = field_example; // {{String}} field to base64 decode and transfer

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getArticleTagSubjectField(articleId, tagId, field, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();
            var articleId = articleId_example;  // String | specified article id
            var tagId = tagId_example;  // String | specified tag id
            var field = field_example;  // String | field to base64 decode and transfer

            try
            {
                Tag result = apiInstance.getArticleTagSubjectField(articleId, tagId, field);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.getArticleTagSubjectField: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();
$articleId = articleId_example; // String | specified article id
$tagId = tagId_example; // String | specified tag id
$field = field_example; // String | field to base64 decode and transfer

try {
    $result = $api_instance->getArticleTagSubjectField($articleId, $tagId, $field);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->getArticleTagSubjectField: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();
my $articleId = articleId_example; # String | specified article id
my $tagId = tagId_example; # String | specified tag id
my $field = field_example; # String | field to base64 decode and transfer

eval { 
    my $result = $api_instance->getArticleTagSubjectField(articleId => $articleId, tagId => $tagId, field => $field);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->getArticleTagSubjectField: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()
articleId = articleId_example # String | specified article id
tagId = tagId_example # String | specified tag id
field = field_example # String | field to base64 decode and transfer

try: 
    api_response = api_instance.get_article_tag_subject_field(articleId, tagId, field)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->getArticleTagSubjectField: %s\n" % e)

Parameters

Path parameters

Name	Description
articleId*	String specified article id Required
tagId*	String specified tag id Required
field*	String field to base64 decode and transfer Required

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 404 - field, tag or article not found

Status: 405 - invalid field

Status: 500 - internal server error

getArticleTagView

Get view of tags within speicified block. Access granted to app tokens of account holder and contact token of accounts with which the article is shared.

/content/articles/{articleId}/tagBlocks/{blockId}/view

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//content/articles/{articleId}/tagBlocks/{blockId}/view?types="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        String blockId = blockId_example; // String | specified block id
        array[String] types = ; // array[String] | limit results to tags of types
        try {
            array[inline_response_200_1] result = apiInstance.getArticleTagView(articleId, blockId, types);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getArticleTagView");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        String blockId = blockId_example; // String | specified block id
        array[String] types = ; // array[String] | limit results to tags of types
        try {
            array[inline_response_200_1] result = apiInstance.getArticleTagView(articleId, blockId, types);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getArticleTagView");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *articleId = articleId_example; // specified article id
String *blockId = blockId_example; // specified block id
array[String] *types = ; // limit results to tags of types (optional)

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance getArticleTagViewWith:articleId
    blockId:blockId
    types:types
              completionHandler: ^(array[inline_response_200_1] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var articleId = articleId_example; // {{String}} specified article id
var blockId = blockId_example; // {{String}} specified block id
var opts = { 
  'types':  // {{array[String]}} limit results to tags of types
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getArticleTagView(articleId, blockId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();
            var articleId = articleId_example;  // String | specified article id
            var blockId = blockId_example;  // String | specified block id
            var types = new array[String](); // array[String] | limit results to tags of types (optional) 

            try
            {
                array[inline_response_200_1] result = apiInstance.getArticleTagView(articleId, blockId, types);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.getArticleTagView: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();
$articleId = articleId_example; // String | specified article id
$blockId = blockId_example; // String | specified block id
$types = ; // array[String] | limit results to tags of types

try {
    $result = $api_instance->getArticleTagView($articleId, $blockId, $types);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->getArticleTagView: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();
my $articleId = articleId_example; # String | specified article id
my $blockId = blockId_example; # String | specified block id
my $types = []; # array[String] | limit results to tags of types

eval { 
    my $result = $api_instance->getArticleTagView(articleId => $articleId, blockId => $blockId, types => $types);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->getArticleTagView: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()
articleId = articleId_example # String | specified article id
blockId = blockId_example # String | specified block id
types =  # array[String] | limit results to tags of types (optional)

try: 
    api_response = api_instance.get_article_tag_view(articleId, blockId, types=types)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->getArticleTagView: %s\n" % e)

Parameters

Path parameters

Name	Description
articleId*	String specified article id Required
blockId*	String specified block id Required

Query parameters

Name	Description
types	array[String] limit results to tags of types

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 404 - block or article not found

Status: 500 - internal server error

getArticleTags

Get tags within specified block. Access granted to app tokens of account holder and contact tokens of accounts with which the article is shared.

/content/articles/{articleId}/tagBlocks/{blockId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//content/articles/{articleId}/tagBlocks/{blockId}?types="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        String blockId = blockId_example; // String | specified block id
        array[String] types = ; // array[String] | limit results to tags of types
        try {
            array[inline_response_200_1] result = apiInstance.getArticleTags(articleId, blockId, types);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getArticleTags");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        String blockId = blockId_example; // String | specified block id
        array[String] types = ; // array[String] | limit results to tags of types
        try {
            array[inline_response_200_1] result = apiInstance.getArticleTags(articleId, blockId, types);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getArticleTags");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *articleId = articleId_example; // specified article id
String *blockId = blockId_example; // specified block id
array[String] *types = ; // limit results to tags of types (optional)

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance getArticleTagsWith:articleId
    blockId:blockId
    types:types
              completionHandler: ^(array[inline_response_200_1] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var articleId = articleId_example; // {{String}} specified article id
var blockId = blockId_example; // {{String}} specified block id
var opts = { 
  'types':  // {{array[String]}} limit results to tags of types
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getArticleTags(articleId, blockId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();
            var articleId = articleId_example;  // String | specified article id
            var blockId = blockId_example;  // String | specified block id
            var types = new array[String](); // array[String] | limit results to tags of types (optional) 

            try
            {
                array[inline_response_200_1] result = apiInstance.getArticleTags(articleId, blockId, types);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.getArticleTags: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();
$articleId = articleId_example; // String | specified article id
$blockId = blockId_example; // String | specified block id
$types = ; // array[String] | limit results to tags of types

try {
    $result = $api_instance->getArticleTags($articleId, $blockId, $types);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->getArticleTags: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();
my $articleId = articleId_example; # String | specified article id
my $blockId = blockId_example; # String | specified block id
my $types = []; # array[String] | limit results to tags of types

eval { 
    my $result = $api_instance->getArticleTags(articleId => $articleId, blockId => $blockId, types => $types);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->getArticleTags: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()
articleId = articleId_example # String | specified article id
blockId = blockId_example # String | specified block id
types =  # array[String] | limit results to tags of types (optional)

try: 
    api_response = api_instance.get_article_tags(articleId, blockId, types=types)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->getArticleTags: %s\n" % e)

Parameters

Path parameters

Name	Description
articleId*	String specified article id Required
blockId*	String specified block id Required

Query parameters

Name	Description
types	array[String] limit results to tags of types

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 404 - block or article not found

Status: 500 - internal server error

getArticleViews

Get the article views within specified block. Access granted for app token or contact token. All of the articles are returned for the app token, but only the shared articles are returned for the contact token. An article is shared by assigning a common group to an article or assigning a label to an article that has assigned a common group.

/content/articleBlocks/{blockId}/view

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//content/articleBlocks/{blockId}/view"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        String blockId = blockId_example; // String | specified group id
        try {
            array[inline_response_200_1] result = apiInstance.getArticleViews(blockId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getArticleViews");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String blockId = blockId_example; // String | specified group id
        try {
            array[inline_response_200_1] result = apiInstance.getArticleViews(blockId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getArticleViews");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *blockId = blockId_example; // specified group id

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance getArticleViewsWith:blockId
              completionHandler: ^(array[inline_response_200_1] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var blockId = blockId_example; // {{String}} specified group id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getArticleViews(blockId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();
            var blockId = blockId_example;  // String | specified group id

            try
            {
                array[inline_response_200_1] result = apiInstance.getArticleViews(blockId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.getArticleViews: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();
$blockId = blockId_example; // String | specified group id

try {
    $result = $api_instance->getArticleViews($blockId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->getArticleViews: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();
my $blockId = blockId_example; # String | specified group id

eval { 
    my $result = $api_instance->getArticleViews(blockId => $blockId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->getArticleViews: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()
blockId = blockId_example # String | specified group id

try: 
    api_response = api_instance.get_article_views(blockId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->getArticleViews: %s\n" % e)

Parameters

Path parameters

Name	Description
blockId*	String specified group id Required

Responses

Status: 200 - successful operation

Schema

Status: 401 - permission denied

Status: 404 - block not found

Status: 500 - internal server error

getArticles

Get the articles within specified block. Access granted for app token or contact token. All of the articles are returned for the app token, but only the shared articles are returned for the contact token. An article is shared by assigning a common group to an article or assigning a label to an article that has assigned a common group.

/content/articleBlocks/{blockId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//content/articleBlocks/{blockId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        String blockId = blockId_example; // String | specified group id
        try {
            array[Article] result = apiInstance.getArticles(blockId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getArticles");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String blockId = blockId_example; // String | specified group id
        try {
            array[Article] result = apiInstance.getArticles(blockId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getArticles");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *blockId = blockId_example; // specified group id

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance getArticlesWith:blockId
              completionHandler: ^(array[Article] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var blockId = blockId_example; // {{String}} specified group id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getArticles(blockId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();
            var blockId = blockId_example;  // String | specified group id

            try
            {
                array[Article] result = apiInstance.getArticles(blockId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.getArticles: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();
$blockId = blockId_example; // String | specified group id

try {
    $result = $api_instance->getArticles($blockId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->getArticles: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();
my $blockId = blockId_example; # String | specified group id

eval { 
    my $result = $api_instance->getArticles(blockId => $blockId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->getArticles: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()
blockId = blockId_example # String | specified group id

try: 
    api_response = api_instance.get_articles(blockId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->getArticles: %s\n" % e)

Parameters

Path parameters

Name	Description
blockId*	String specified group id Required

Responses

Status: 200 - successful operation

Schema

Status: 401 - permission denied

Status: 404 - block not found

Status: 500 - internal server error

getLabels

Get labels with which to organize the articles. Contacts requesting the labels will only retrieve the labels with which they are shared. Access granted to the app tokens of the account holder and connected contact tokens.

/content/labels

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//content/labels"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        try {
            array[Label] result = apiInstance.getLabels();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getLabels");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        try {
            array[Label] result = apiInstance.getLabels();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getLabels");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance getLabelsWithCompletionHandler: 
              ^(array[Label] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getLabels(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();

            try
            {
                array[Label] result = apiInstance.getLabels();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.getLabels: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();

try {
    $result = $api_instance->getLabels();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->getLabels: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();

eval { 
    my $result = $api_instance->getLabels();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->getLabels: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()

try: 
    api_response = api_instance.get_labels()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->getLabels: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation

Schema

Status: 401 - invalid token

Status: 500 - internal server error

removeArticle

Remove specified article. Access granted to app token of account holder.

/content/articles/{articleId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
"//content/articles/{articleId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        try {
            apiInstance.removeArticle(articleId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#removeArticle");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        try {
            apiInstance.removeArticle(articleId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#removeArticle");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *articleId = articleId_example; // specified article id

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance removeArticleWith:articleId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var articleId = articleId_example; // {{String}} specified article id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeArticle(articleId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();
            var articleId = articleId_example;  // String | specified article id

            try
            {
                apiInstance.removeArticle(articleId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.removeArticle: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();
$articleId = articleId_example; // String | specified article id

try {
    $api_instance->removeArticle($articleId);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->removeArticle: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();
my $articleId = articleId_example; # String | specified article id

eval { 
    $api_instance->removeArticle(articleId => $articleId);
};
if ($@) {
    warn "Exception when calling ContentApi->removeArticle: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()
articleId = articleId_example # String | specified article id

try: 
    api_instance.remove_article(articleId)
except ApiException as e:
    print("Exception when calling ContentApi->removeArticle: %s\n" % e)

Parameters

Path parameters

Name	Description
articleId*	String specified article id Required

Responses

Status: 200 - success

Status: 401 - invalid password

Status: 404 - article not found

Status: 500 - internal server error

removeArticleAsset

Remove an asset from an article. Access granted to app tokens of the account holder.

/content/articles/{articleId}/assets/{assetId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
"//content/articles/{articleId}/assets/{assetId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        String assetId = assetId_example; // String | specified asset id
        try {
            apiInstance.removeArticleAsset(articleId, assetId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#removeArticleAsset");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        String assetId = assetId_example; // String | specified asset id
        try {
            apiInstance.removeArticleAsset(articleId, assetId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#removeArticleAsset");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *articleId = articleId_example; // specified article id
String *assetId = assetId_example; // specified asset id

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance removeArticleAssetWith:articleId
    assetId:assetId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var articleId = articleId_example; // {{String}} specified article id
var assetId = assetId_example; // {{String}} specified asset id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeArticleAsset(articleId, assetId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();
            var articleId = articleId_example;  // String | specified article id
            var assetId = assetId_example;  // String | specified asset id

            try
            {
                apiInstance.removeArticleAsset(articleId, assetId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.removeArticleAsset: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();
$articleId = articleId_example; // String | specified article id
$assetId = assetId_example; // String | specified asset id

try {
    $api_instance->removeArticleAsset($articleId, $assetId);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->removeArticleAsset: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();
my $articleId = articleId_example; # String | specified article id
my $assetId = assetId_example; # String | specified asset id

eval { 
    $api_instance->removeArticleAsset(articleId => $articleId, assetId => $assetId);
};
if ($@) {
    warn "Exception when calling ContentApi->removeArticleAsset: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()
articleId = articleId_example # String | specified article id
assetId = assetId_example # String | specified asset id

try: 
    api_instance.remove_article_asset(articleId, assetId)
except ApiException as e:
    print("Exception when calling ContentApi->removeArticleAsset: %s\n" % e)

Parameters

Path parameters

Name	Description
articleId*	String specified article id Required
assetId*	String specified asset id Required

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 404 - asset or article not found

Status: 500 - internal server error

removeArticleTag

Remove a tag from an article. Access granted to app tokens of account holder and the contact tokens of the account that created the tag.

/content/articles/{articleId}/tags/{tagId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
"//content/articles/{articleId}/tags/{tagId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        String tagId = tagId_example; // String | specified tag id
        try {
            apiInstance.removeArticleTag(articleId, tagId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#removeArticleTag");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        String tagId = tagId_example; // String | specified tag id
        try {
            apiInstance.removeArticleTag(articleId, tagId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#removeArticleTag");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *articleId = articleId_example; // specified article id
String *tagId = tagId_example; // specified tag id

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance removeArticleTagWith:articleId
    tagId:tagId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var articleId = articleId_example; // {{String}} specified article id
var tagId = tagId_example; // {{String}} specified tag id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeArticleTag(articleId, tagId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();
            var articleId = articleId_example;  // String | specified article id
            var tagId = tagId_example;  // String | specified tag id

            try
            {
                apiInstance.removeArticleTag(articleId, tagId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.removeArticleTag: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();
$articleId = articleId_example; // String | specified article id
$tagId = tagId_example; // String | specified tag id

try {
    $api_instance->removeArticleTag($articleId, $tagId);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->removeArticleTag: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();
my $articleId = articleId_example; # String | specified article id
my $tagId = tagId_example; # String | specified tag id

eval { 
    $api_instance->removeArticleTag(articleId => $articleId, tagId => $tagId);
};
if ($@) {
    warn "Exception when calling ContentApi->removeArticleTag: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()
articleId = articleId_example # String | specified article id
tagId = tagId_example # String | specified tag id

try: 
    api_instance.remove_article_tag(articleId, tagId)
except ApiException as e:
    print("Exception when calling ContentApi->removeArticleTag: %s\n" % e)

Parameters

Path parameters

Name	Description
articleId*	String specified article id Required
tagId*	String specified tag id Required

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 404 - tag or article not found

Status: 500 - internal server error

removeLabel

Remove specified label. Access granted the the app tokens of the account holder.

/content/labels/{labelId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
"//content/labels/{labelId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        String labelId = labelId_example; // String | specified label id
        try {
            apiInstance.removeLabel(labelId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#removeLabel");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String labelId = labelId_example; // String | specified label id
        try {
            apiInstance.removeLabel(labelId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#removeLabel");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *labelId = labelId_example; // specified label id

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance removeLabelWith:labelId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var labelId = labelId_example; // {{String}} specified label id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeLabel(labelId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();
            var labelId = labelId_example;  // String | specified label id

            try
            {
                apiInstance.removeLabel(labelId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.removeLabel: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();
$labelId = labelId_example; // String | specified label id

try {
    $api_instance->removeLabel($labelId);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->removeLabel: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();
my $labelId = labelId_example; # String | specified label id

eval { 
    $api_instance->removeLabel(labelId => $labelId);
};
if ($@) {
    warn "Exception when calling ContentApi->removeLabel: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()
labelId = labelId_example # String | specified label id

try: 
    api_instance.remove_label(labelId)
except ApiException as e:
    print("Exception when calling ContentApi->removeLabel: %s\n" % e)

Parameters

Path parameters

Name	Description
labelId*	String specified label id Required

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 404 - label not found

Status: 500 - internal server error

setArticleConfirmed

Set confirmed state of the article. Until the confirmed state has been set to true, the article will not be visible to contacts with which the article is shared. Access granted to the app tokens of the acocunt holder.

/content/articles/{articleId}/confirmed

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Content-Type: application/json"\
"//content/articles/{articleId}/confirmed"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        Boolean body = ; // Boolean | 
        try {
            apiInstance.setArticleConfirmed(articleId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#setArticleConfirmed");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        Boolean body = ; // Boolean | 
        try {
            apiInstance.setArticleConfirmed(articleId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#setArticleConfirmed");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *articleId = articleId_example; // specified article id
Boolean *body = ; //  (optional)

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance setArticleConfirmedWith:articleId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var articleId = articleId_example; // {{String}} specified article id
var opts = { 
  'body':  // {{Boolean}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setArticleConfirmed(articleId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();
            var articleId = articleId_example;  // String | specified article id
            var body = new Boolean(); // Boolean |  (optional) 

            try
            {
                apiInstance.setArticleConfirmed(articleId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.setArticleConfirmed: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();
$articleId = articleId_example; // String | specified article id
$body = ; // Boolean | 

try {
    $api_instance->setArticleConfirmed($articleId, $body);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->setArticleConfirmed: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();
my $articleId = articleId_example; # String | specified article id
my $body = WWW::SwaggerClient::Object::Boolean->new(); # Boolean | 

eval { 
    $api_instance->setArticleConfirmed(articleId => $articleId, body => $body);
};
if ($@) {
    warn "Exception when calling ContentApi->setArticleConfirmed: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()
articleId = articleId_example # String | specified article id
body =  # Boolean |  (optional)

try: 
    api_instance.set_article_confirmed(articleId, body=body)
except ApiException as e:
    print("Exception when calling ContentApi->setArticleConfirmed: %s\n" % e)

Parameters

Path parameters

Name	Description
articleId*	String specified article id Required

Body parameters

Name	Description
body

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 404 - article not found

Status: 500 - internal server error

setArticleGroup

Assign a sharing group for the specified article. Contacts with the same sharing group will have access to the article. Access granted to app token of account holder.

/content/articles/{articleId}/groups/{groupId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
"//content/articles/{articleId}/groups/{groupId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        String groupId = groupId_example; // String | specified share group id
        try {
            apiInstance.setArticleGroup(articleId, groupId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#setArticleGroup");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        String groupId = groupId_example; // String | specified share group id
        try {
            apiInstance.setArticleGroup(articleId, groupId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#setArticleGroup");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *articleId = articleId_example; // specified article id
String *groupId = groupId_example; // specified share group id

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance setArticleGroupWith:articleId
    groupId:groupId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var articleId = articleId_example; // {{String}} specified article id
var groupId = groupId_example; // {{String}} specified share group id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setArticleGroup(articleId, groupId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();
            var articleId = articleId_example;  // String | specified article id
            var groupId = groupId_example;  // String | specified share group id

            try
            {
                apiInstance.setArticleGroup(articleId, groupId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.setArticleGroup: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();
$articleId = articleId_example; // String | specified article id
$groupId = groupId_example; // String | specified share group id

try {
    $api_instance->setArticleGroup($articleId, $groupId);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->setArticleGroup: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();
my $articleId = articleId_example; # String | specified article id
my $groupId = groupId_example; # String | specified share group id

eval { 
    $api_instance->setArticleGroup(articleId => $articleId, groupId => $groupId);
};
if ($@) {
    warn "Exception when calling ContentApi->setArticleGroup: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()
articleId = articleId_example # String | specified article id
groupId = groupId_example # String | specified share group id

try: 
    api_instance.set_article_group(articleId, groupId)
except ApiException as e:
    print("Exception when calling ContentApi->setArticleGroup: %s\n" % e)

Parameters

Path parameters

Name	Description
articleId*	String specified article id Required
groupId*	String specified share group id Required

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 404 - group or article not found

Status: 500 - internal server error

setArticleLabel

Assign a label to an article. If the label has been assigned a sharing group the article will be accessible by contacts within that group. Access is granted to app tokens of the account holder.

/content/articles/{articleId}/labels/{labelId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
"//content/articles/{articleId}/labels/{labelId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        String labelId = labelId_example; // String | specified label id
        try {
            apiInstance.setArticleLabel(articleId, labelId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#setArticleLabel");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        String labelId = labelId_example; // String | specified label id
        try {
            apiInstance.setArticleLabel(articleId, labelId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#setArticleLabel");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *articleId = articleId_example; // specified article id
String *labelId = labelId_example; // specified label id

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance setArticleLabelWith:articleId
    labelId:labelId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var articleId = articleId_example; // {{String}} specified article id
var labelId = labelId_example; // {{String}} specified label id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setArticleLabel(articleId, labelId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();
            var articleId = articleId_example;  // String | specified article id
            var labelId = labelId_example;  // String | specified label id

            try
            {
                apiInstance.setArticleLabel(articleId, labelId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.setArticleLabel: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();
$articleId = articleId_example; // String | specified article id
$labelId = labelId_example; // String | specified label id

try {
    $api_instance->setArticleLabel($articleId, $labelId);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->setArticleLabel: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();
my $articleId = articleId_example; # String | specified article id
my $labelId = labelId_example; # String | specified label id

eval { 
    $api_instance->setArticleLabel(articleId => $articleId, labelId => $labelId);
};
if ($@) {
    warn "Exception when calling ContentApi->setArticleLabel: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()
articleId = articleId_example # String | specified article id
labelId = labelId_example # String | specified label id

try: 
    api_instance.set_article_label(articleId, labelId)
except ApiException as e:
    print("Exception when calling ContentApi->setArticleLabel: %s\n" % e)

Parameters

Path parameters

Name	Description
articleId*	String specified article id Required
labelId*	String specified label id Required

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 404 - label or article not found

Status: 500 - internal server error

setArticleSubject

Set subject for article. Access granted to app token of account holder.

/content/articles/{articleId}/subject

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Content-Type: application/json"\
"//content/articles/{articleId}/subject"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        ArticleId_subject_body body = ; // ArticleId_subject_body | 
        try {
            apiInstance.setArticleSubject(articleId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#setArticleSubject");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String articleId = articleId_example; // String | specified article id
        ArticleId_subject_body body = ; // ArticleId_subject_body | 
        try {
            apiInstance.setArticleSubject(articleId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#setArticleSubject");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *articleId = articleId_example; // specified article id
ArticleId_subject_body *body = ; //  (optional)

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance setArticleSubjectWith:articleId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var articleId = articleId_example; // {{String}} specified article id
var opts = { 
  'body':  // {{ArticleId_subject_body}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setArticleSubject(articleId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();
            var articleId = articleId_example;  // String | specified article id
            var body = new ArticleId_subject_body(); // ArticleId_subject_body |  (optional) 

            try
            {
                apiInstance.setArticleSubject(articleId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.setArticleSubject: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();
$articleId = articleId_example; // String | specified article id
$body = ; // ArticleId_subject_body | 

try {
    $api_instance->setArticleSubject($articleId, $body);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->setArticleSubject: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();
my $articleId = articleId_example; # String | specified article id
my $body = WWW::SwaggerClient::Object::ArticleId_subject_body->new(); # ArticleId_subject_body | 

eval { 
    $api_instance->setArticleSubject(articleId => $articleId, body => $body);
};
if ($@) {
    warn "Exception when calling ContentApi->setArticleSubject: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()
articleId = articleId_example # String | specified article id
body =  # ArticleId_subject_body |  (optional)

try: 
    api_instance.set_article_subject(articleId, body=body)
except ApiException as e:
    print("Exception when calling ContentApi->setArticleSubject: %s\n" % e)

Parameters

Path parameters

Name	Description
articleId*	String specified article id Required

Body parameters

Name	Description
body

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 404 - article not found

Status: 500 - internal server error

setLabelGroup

Set a sharing group for the label and articles assigned to the label. Access granted to app tokens of the account holder.

/content/labels/{labelId}/groups/{groupId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
"//content/labels/{labelId}/groups/{groupId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        String labelId = labelId_example; // String | specified label id
        String groupId = groupId_example; // String | specified group id
        try {
            apiInstance.setLabelGroup(labelId, groupId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#setLabelGroup");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String labelId = labelId_example; // String | specified label id
        String groupId = groupId_example; // String | specified group id
        try {
            apiInstance.setLabelGroup(labelId, groupId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#setLabelGroup");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *labelId = labelId_example; // specified label id
String *groupId = groupId_example; // specified group id

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance setLabelGroupWith:labelId
    groupId:groupId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var labelId = labelId_example; // {{String}} specified label id
var groupId = groupId_example; // {{String}} specified group id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setLabelGroup(labelId, groupId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();
            var labelId = labelId_example;  // String | specified label id
            var groupId = groupId_example;  // String | specified group id

            try
            {
                apiInstance.setLabelGroup(labelId, groupId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.setLabelGroup: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();
$labelId = labelId_example; // String | specified label id
$groupId = groupId_example; // String | specified group id

try {
    $api_instance->setLabelGroup($labelId, $groupId);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->setLabelGroup: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();
my $labelId = labelId_example; # String | specified label id
my $groupId = groupId_example; # String | specified group id

eval { 
    $api_instance->setLabelGroup(labelId => $labelId, groupId => $groupId);
};
if ($@) {
    warn "Exception when calling ContentApi->setLabelGroup: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()
labelId = labelId_example # String | specified label id
groupId = groupId_example # String | specified group id

try: 
    api_instance.set_label_group(labelId, groupId)
except ApiException as e:
    print("Exception when calling ContentApi->setLabelGroup: %s\n" % e)

Parameters

Path parameters

Name	Description
labelId*	String specified label id Required
groupId*	String specified group id Required

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 404 - group or label not found

Status: 500 - internal server error

updateLabel

Update specified label. Access granted to app tokens of the account holder.

/content/labels/{labelId}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Content-Type: application/json"\
"//content/labels/{labelId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContentApi;

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

public class ContentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ContentApi apiInstance = new ContentApi();
        String labelId = labelId_example; // String | specified group id
        Labels_labelId_body body = ; // Labels_labelId_body | 
        try {
            apiInstance.updateLabel(labelId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#updateLabel");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContentApi;

public class ContentApiExample {

    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String labelId = labelId_example; // String | specified group id
        Labels_labelId_body body = ; // Labels_labelId_body | 
        try {
            apiInstance.updateLabel(labelId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#updateLabel");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *labelId = labelId_example; // specified group id
Labels_labelId_body *body = ; //  (optional)

ContentApi *apiInstance = [[ContentApi alloc] init];

[apiInstance updateLabelWith:labelId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ContentApi()
var labelId = labelId_example; // {{String}} specified group id
var opts = { 
  'body':  // {{Labels_labelId_body}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateLabel(labelId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContentApi();
            var labelId = labelId_example;  // String | specified group id
            var body = new Labels_labelId_body(); // Labels_labelId_body |  (optional) 

            try
            {
                apiInstance.updateLabel(labelId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContentApi.updateLabel: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContentApi();
$labelId = labelId_example; // String | specified group id
$body = ; // Labels_labelId_body | 

try {
    $api_instance->updateLabel($labelId, $body);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->updateLabel: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContentApi;


my $api_instance = WWW::SwaggerClient::ContentApi->new();
my $labelId = labelId_example; # String | specified group id
my $body = WWW::SwaggerClient::Object::Labels_labelId_body->new(); # Labels_labelId_body | 

eval { 
    $api_instance->updateLabel(labelId => $labelId, body => $body);
};
if ($@) {
    warn "Exception when calling ContentApi->updateLabel: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ContentApi()
labelId = labelId_example # String | specified group id
body =  # Labels_labelId_body |  (optional)

try: 
    api_instance.update_label(labelId, body=body)
except ApiException as e:
    print("Exception when calling ContentApi->updateLabel: %s\n" % e)

Parameters

Path parameters

Name	Description
labelId*	String specified group id Required

Body parameters

Name	Description
body

Responses

Status: 200 - successful operation

Status: 401 - invalid token

Status: 500 - internal server error

Conversation

addDialogue

Create and host a new dialogue. Authroization granted to an app token of the account holder.

/conversation/dialogues

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//conversation/dialogues"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        try {
            array[Dialogue] result = apiInstance.addDialogue();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#addDialogue");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        try {
            array[Dialogue] result = apiInstance.addDialogue();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#addDialogue");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance addDialogueWithCompletionHandler: 
              ^(array[Dialogue] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addDialogue(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();

            try
            {
                array[Dialogue] result = apiInstance.addDialogue();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.addDialogue: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();

try {
    $result = $api_instance->addDialogue();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->addDialogue: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();

eval { 
    my $result = $api_instance->addDialogue();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationApi->addDialogue: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()

try: 
    api_response = api_instance.add_dialogue()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationApi->addDialogue: %s\n" % e)

Parameters

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 500 - internal server error

addDialogueInsight

Add insight to a dialogue. This endpoint will automatically invoke the add insight on the contact's node. Authorization is granted to the app token of the account holder.

/conversation/dialogues/{dialogueId}/cards/{cardId}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
"//conversation/dialogues/{dialogueId}/cards/{cardId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String cardId = cardId_example; // String | specified card id
        try {
            apiInstance.addDialogueInsight(dialogueId, cardId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#addDialogueInsight");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String cardId = cardId_example; // String | specified card id
        try {
            apiInstance.addDialogueInsight(dialogueId, cardId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#addDialogueInsight");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dialogueId = dialogueId_example; // specified dialogue id
String *cardId = cardId_example; // specified card id

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance addDialogueInsightWith:dialogueId
    cardId:cardId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var dialogueId = dialogueId_example; // {{String}} specified dialogue id
var cardId = cardId_example; // {{String}} specified card id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addDialogueInsight(dialogueId, cardId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dialogueId = dialogueId_example;  // String | specified dialogue id
            var cardId = cardId_example;  // String | specified card id

            try
            {
                apiInstance.addDialogueInsight(dialogueId, cardId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.addDialogueInsight: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dialogueId = dialogueId_example; // String | specified dialogue id
$cardId = cardId_example; // String | specified card id

try {
    $api_instance->addDialogueInsight($dialogueId, $cardId);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->addDialogueInsight: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dialogueId = dialogueId_example; # String | specified dialogue id
my $cardId = cardId_example; # String | specified card id

eval { 
    $api_instance->addDialogueInsight(dialogueId => $dialogueId, cardId => $cardId);
};
if ($@) {
    warn "Exception when calling ConversationApi->addDialogueInsight: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dialogueId = dialogueId_example # String | specified dialogue id
cardId = cardId_example # String | specified card id

try: 
    api_instance.add_dialogue_insight(dialogueId, cardId)
except ApiException as e:
    print("Exception when calling ConversationApi->addDialogueInsight: %s\n" % e)

Parameters

Path parameters

Name	Description
dialogueId*	String specified dialogue id Required
cardId*	String specified card id Required

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 404 - cardId or dialogue not found

Status: 500 - internal server error

addDialogueTopic

Add a topic to a dialogue. The response contains the topicBlock ID and topicBlock revision to which the topic is assigned. Authorization granted to account holder app token or dialogue member contact token who is a member of the dialogue.

/conversation/dialogues/{dialogueId}/topics

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//conversation/dialogues/{dialogueId}/topics"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        try {
            inline_response_201_1 result = apiInstance.addDialogueTopic(dialogueId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#addDialogueTopic");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        try {
            inline_response_201_1 result = apiInstance.addDialogueTopic(dialogueId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#addDialogueTopic");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dialogueId = dialogueId_example; // specified dialogue id

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance addDialogueTopicWith:dialogueId
              completionHandler: ^(inline_response_201_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var dialogueId = dialogueId_example; // {{String}} specified dialogue id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addDialogueTopic(dialogueId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dialogueId = dialogueId_example;  // String | specified dialogue id

            try
            {
                inline_response_201_1 result = apiInstance.addDialogueTopic(dialogueId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.addDialogueTopic: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dialogueId = dialogueId_example; // String | specified dialogue id

try {
    $result = $api_instance->addDialogueTopic($dialogueId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->addDialogueTopic: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dialogueId = dialogueId_example; # String | specified dialogue id

eval { 
    my $result = $api_instance->addDialogueTopic(dialogueId => $dialogueId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationApi->addDialogueTopic: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dialogueId = dialogueId_example # String | specified dialogue id

try: 
    api_response = api_instance.add_dialogue_topic(dialogueId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationApi->addDialogueTopic: %s\n" % e)

Parameters

Path parameters

Name	Description
dialogueId*	String specified dialogue id Required

Responses

Status: 201 - entry created

Schema

Status: 401 - permission denied

Status: 403 - inactive dialogue

Status: 404 - dialogue not found

Status: 500 - internal server error

addInsightDialogue

Create or update an insight. Because the insightId is not know by the contact, it is determined from the token and the dialogueId. Access granted to a connected contact token.

/conversation/insights/{dialogueId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//conversation/insights/{dialogueId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | dialogue with insight id to update
        Long body = ; // Long | 
        try {
            'String' result = apiInstance.addInsightDialogue(dialogueId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#addInsightDialogue");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | dialogue with insight id to update
        Long body = ; // Long | 
        try {
            'String' result = apiInstance.addInsightDialogue(dialogueId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#addInsightDialogue");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dialogueId = dialogueId_example; // dialogue with insight id to update
Long *body = ; //  (optional)

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance addInsightDialogueWith:dialogueId
    body:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var dialogueId = dialogueId_example; // {{String}} dialogue with insight id to update
var opts = { 
  'body':  // {{Long}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addInsightDialogue(dialogueId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dialogueId = dialogueId_example;  // String | dialogue with insight id to update
            var body = new Long(); // Long |  (optional) 

            try
            {
                'String' result = apiInstance.addInsightDialogue(dialogueId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.addInsightDialogue: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dialogueId = dialogueId_example; // String | dialogue with insight id to update
$body = ; // Long | 

try {
    $result = $api_instance->addInsightDialogue($dialogueId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->addInsightDialogue: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dialogueId = dialogueId_example; # String | dialogue with insight id to update
my $body = WWW::SwaggerClient::Object::Long->new(); # Long | 

eval { 
    my $result = $api_instance->addInsightDialogue(dialogueId => $dialogueId, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationApi->addInsightDialogue: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dialogueId = dialogueId_example # String | dialogue with insight id to update
body =  # Long |  (optional)

try: 
    api_response = api_instance.add_insight_dialogue(dialogueId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationApi->addInsightDialogue: %s\n" % e)

Parameters

Path parameters

Name	Description
dialogueId*	String dialogue with insight id to update Required

Body parameters

Name	Description
body

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 404 - dialogue not found

Status: 500 - internal server error

addTopicAsset

Add an asset to a topic. The asset will be processed and transcoded according to the specified transformation. Authorization granted to account holder app token or dialogue member contact token who is also the creator of the topic.

/conversation/dialogues/{dialogueId}/topics/{topicId}/assets

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: multipart/form-data"\
"//conversation/dialogues/{dialogueId}/topics/{topicId}/assets?transforms="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        byte[] fileName = fileName_example; // byte[] | 
        array[String] transforms = ; // array[String] | transforms to apply
        try {
            Asset result = apiInstance.addTopicAsset(dialogueId, topicId, fileName, transforms);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#addTopicAsset");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        byte[] fileName = fileName_example; // byte[] | 
        array[String] transforms = ; // array[String] | transforms to apply
        try {
            Asset result = apiInstance.addTopicAsset(dialogueId, topicId, fileName, transforms);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#addTopicAsset");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dialogueId = dialogueId_example; // specified dialogue id
String *topicId = topicId_example; // specified topic id
byte[] *fileName = fileName_example; //  (optional)
array[String] *transforms = ; // transforms to apply (optional)

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance addTopicAssetWith:dialogueId
    topicId:topicId
    fileName:fileName
    transforms:transforms
              completionHandler: ^(Asset output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var dialogueId = dialogueId_example; // {{String}} specified dialogue id
var topicId = topicId_example; // {{String}} specified topic id
var opts = { 
  'fileName': fileName_example // {{byte[]}} 
  'transforms':  // {{array[String]}} transforms to apply
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addTopicAsset(dialogueIdtopicId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dialogueId = dialogueId_example;  // String | specified dialogue id
            var topicId = topicId_example;  // String | specified topic id
            var fileName = fileName_example;  // byte[] |  (optional) 
            var transforms = new array[String](); // array[String] | transforms to apply (optional) 

            try
            {
                Asset result = apiInstance.addTopicAsset(dialogueId, topicId, fileName, transforms);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.addTopicAsset: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dialogueId = dialogueId_example; // String | specified dialogue id
$topicId = topicId_example; // String | specified topic id
$fileName = fileName_example; // byte[] | 
$transforms = ; // array[String] | transforms to apply

try {
    $result = $api_instance->addTopicAsset($dialogueId, $topicId, $fileName, $transforms);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->addTopicAsset: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dialogueId = dialogueId_example; # String | specified dialogue id
my $topicId = topicId_example; # String | specified topic id
my $fileName = fileName_example; # byte[] | 
my $transforms = []; # array[String] | transforms to apply

eval { 
    my $result = $api_instance->addTopicAsset(dialogueId => $dialogueId, topicId => $topicId, fileName => $fileName, transforms => $transforms);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationApi->addTopicAsset: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dialogueId = dialogueId_example # String | specified dialogue id
topicId = topicId_example # String | specified topic id
fileName = fileName_example # byte[] |  (optional)
transforms =  # array[String] | transforms to apply (optional)

try: 
    api_response = api_instance.add_topic_asset(dialogueId, topicId, fileName=fileName, transforms=transforms)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationApi->addTopicAsset: %s\n" % e)

Parameters

Path parameters

Name	Description
dialogueId*	String specified dialogue id Required
topicId*	String specified topic id Required

Form parameters

Name	Description
fileName	byte[] (binary)

Query parameters

Name	Description
transforms	array[String] transforms to apply

Responses

Status: 201 - success

Schema

Status: 401 - permission denied

Status: 403 - inactive dialogue

Status: 404 - topic or dialogue not found

Status: 500 - internal server error

addTopicTag

Add a tag to specified topic. Authorization granted to account holder app token or dialogue member contact token who has access to the topic. The body of the post contains the subject of the tag, which can have no associated assets.

/conversation/dialogues/{dialogueId}/topics/{topicId}/tags

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//conversation/dialogues/{dialogueId}/topics/{topicId}/tags"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        TopicId_tags_body body = ; // TopicId_tags_body | 
        try {
            inline_response_200_2 result = apiInstance.addTopicTag(dialogueId, topicId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#addTopicTag");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        TopicId_tags_body body = ; // TopicId_tags_body | 
        try {
            inline_response_200_2 result = apiInstance.addTopicTag(dialogueId, topicId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#addTopicTag");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dialogueId = dialogueId_example; // specified dialogue id
String *topicId = topicId_example; // specified topic id
TopicId_tags_body *body = ; //  (optional)

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance addTopicTagWith:dialogueId
    topicId:topicId
    body:body
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var dialogueId = dialogueId_example; // {{String}} specified dialogue id
var topicId = topicId_example; // {{String}} specified topic id
var opts = { 
  'body':  // {{TopicId_tags_body}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addTopicTag(dialogueIdtopicId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dialogueId = dialogueId_example;  // String | specified dialogue id
            var topicId = topicId_example;  // String | specified topic id
            var body = new TopicId_tags_body(); // TopicId_tags_body |  (optional) 

            try
            {
                inline_response_200_2 result = apiInstance.addTopicTag(dialogueId, topicId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.addTopicTag: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dialogueId = dialogueId_example; // String | specified dialogue id
$topicId = topicId_example; // String | specified topic id
$body = ; // TopicId_tags_body | 

try {
    $result = $api_instance->addTopicTag($dialogueId, $topicId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->addTopicTag: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dialogueId = dialogueId_example; # String | specified dialogue id
my $topicId = topicId_example; # String | specified topic id
my $body = WWW::SwaggerClient::Object::TopicId_tags_body->new(); # TopicId_tags_body | 

eval { 
    my $result = $api_instance->addTopicTag(dialogueId => $dialogueId, topicId => $topicId, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationApi->addTopicTag: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dialogueId = dialogueId_example # String | specified dialogue id
topicId = topicId_example # String | specified topic id
body =  # TopicId_tags_body |  (optional)

try: 
    api_response = api_instance.add_topic_tag(dialogueId, topicId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationApi->addTopicTag: %s\n" % e)

Parameters

Path parameters

Name	Description
dialogueId*	String specified dialogue id Required
topicId*	String specified topic id Required

Body parameters

Name	Description
body

Responses

Status: 201 - entry created

Schema

Status: 401 - permission denied

Status: 403 - inactive dialogue

Status: 404 - topic or dialogue not found

Status: 500 - internal server error

conversationDialoguesDialogueIdTopicsTopicIdConfirmedPut

After the assets have been uploaded and the subject has been set, the topic should be set to confirmed (true) to make the topic available to others. Authorization granted to account holder app token or dialogue member contact token who is also the creator of the topic.

/conversation/dialogues/{dialogueId}/topics/{topicId}/confirmed

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Content-Type: application/json"\
"//conversation/dialogues/{dialogueId}/topics/{topicId}/confirmed"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        Boolean body = ; // Boolean | 
        try {
            apiInstance.conversationDialoguesDialogueIdTopicsTopicIdConfirmedPut(dialogueId, topicId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#conversationDialoguesDialogueIdTopicsTopicIdConfirmedPut");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        Boolean body = ; // Boolean | 
        try {
            apiInstance.conversationDialoguesDialogueIdTopicsTopicIdConfirmedPut(dialogueId, topicId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#conversationDialoguesDialogueIdTopicsTopicIdConfirmedPut");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dialogueId = dialogueId_example; // specified dialogue id
String *topicId = topicId_example; // specified topic id
Boolean *body = ; //  (optional)

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance conversationDialoguesDialogueIdTopicsTopicIdConfirmedPutWith:dialogueId
    topicId:topicId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var dialogueId = dialogueId_example; // {{String}} specified dialogue id
var topicId = topicId_example; // {{String}} specified topic id
var opts = { 
  'body':  // {{Boolean}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.conversationDialoguesDialogueIdTopicsTopicIdConfirmedPut(dialogueIdtopicId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dialogueId = dialogueId_example;  // String | specified dialogue id
            var topicId = topicId_example;  // String | specified topic id
            var body = new Boolean(); // Boolean |  (optional) 

            try
            {
                apiInstance.conversationDialoguesDialogueIdTopicsTopicIdConfirmedPut(dialogueId, topicId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.conversationDialoguesDialogueIdTopicsTopicIdConfirmedPut: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dialogueId = dialogueId_example; // String | specified dialogue id
$topicId = topicId_example; // String | specified topic id
$body = ; // Boolean | 

try {
    $api_instance->conversationDialoguesDialogueIdTopicsTopicIdConfirmedPut($dialogueId, $topicId, $body);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->conversationDialoguesDialogueIdTopicsTopicIdConfirmedPut: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dialogueId = dialogueId_example; # String | specified dialogue id
my $topicId = topicId_example; # String | specified topic id
my $body = WWW::SwaggerClient::Object::Boolean->new(); # Boolean | 

eval { 
    $api_instance->conversationDialoguesDialogueIdTopicsTopicIdConfirmedPut(dialogueId => $dialogueId, topicId => $topicId, body => $body);
};
if ($@) {
    warn "Exception when calling ConversationApi->conversationDialoguesDialogueIdTopicsTopicIdConfirmedPut: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dialogueId = dialogueId_example # String | specified dialogue id
topicId = topicId_example # String | specified topic id
body =  # Boolean |  (optional)

try: 
    api_instance.conversation_dialogues_dialogue_id_topics_topic_id_confirmed_put(dialogueId, topicId, body=body)
except ApiException as e:
    print("Exception when calling ConversationApi->conversationDialoguesDialogueIdTopicsTopicIdConfirmedPut: %s\n" % e)

Parameters

Path parameters

Name	Description
dialogueId*	String specified dialogue id Required
topicId*	String specified topic id Required

Body parameters

Name	Description
body

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 403 - inactive dialogue

Status: 404 - topic or dialogue not found

Status: 500 - internal server error

getDialogueTopic

Retrieve a specified dialogue topic. Authorization granted to account holder app token or dialogue member contact token who is a member of the dialogue.

/conversation/dialogues/{dialogueId}/topics/{topicId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//conversation/dialogues/{dialogueId}/topics/{topicId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        try {
            Topic result = apiInstance.getDialogueTopic(dialogueId, topicId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#getDialogueTopic");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        try {
            Topic result = apiInstance.getDialogueTopic(dialogueId, topicId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#getDialogueTopic");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dialogueId = dialogueId_example; // specified dialogue id
String *topicId = topicId_example; // specified topic id

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance getDialogueTopicWith:dialogueId
    topicId:topicId
              completionHandler: ^(Topic output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var dialogueId = dialogueId_example; // {{String}} specified dialogue id
var topicId = topicId_example; // {{String}} specified topic id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDialogueTopic(dialogueId, topicId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dialogueId = dialogueId_example;  // String | specified dialogue id
            var topicId = topicId_example;  // String | specified topic id

            try
            {
                Topic result = apiInstance.getDialogueTopic(dialogueId, topicId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.getDialogueTopic: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dialogueId = dialogueId_example; // String | specified dialogue id
$topicId = topicId_example; // String | specified topic id

try {
    $result = $api_instance->getDialogueTopic($dialogueId, $topicId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getDialogueTopic: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dialogueId = dialogueId_example; # String | specified dialogue id
my $topicId = topicId_example; # String | specified topic id

eval { 
    my $result = $api_instance->getDialogueTopic(dialogueId => $dialogueId, topicId => $topicId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationApi->getDialogueTopic: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dialogueId = dialogueId_example # String | specified dialogue id
topicId = topicId_example # String | specified topic id

try: 
    api_response = api_instance.get_dialogue_topic(dialogueId, topicId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationApi->getDialogueTopic: %s\n" % e)

Parameters

Path parameters

Name	Description
dialogueId*	String specified dialogue id Required
topicId*	String specified topic id Required

Responses

Status: 200 - successful operation

Schema

Status: 401 - permission denied

Status: 404 - topic or dialogue not found

Status: 500 - internal server error

getDialogueTopicSubjectField

Base64 decode and retrieve a specified field from subject of dialogue topic. Authorization granted to account holder app token or dialogue member contact token who is a member of the dialogue.

/conversation/dialogues/{dialogueId}/topics/{topicId}/subject/{field}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/octet-stream"\
"//conversation/dialogues/{dialogueId}/topics/{topicId}/subject/{field}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        String field = field_example; // String | field to base64 decode and retrieve
        try {
            byte[] result = apiInstance.getDialogueTopicSubjectField(dialogueId, topicId, field);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#getDialogueTopicSubjectField");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        String field = field_example; // String | field to base64 decode and retrieve
        try {
            byte[] result = apiInstance.getDialogueTopicSubjectField(dialogueId, topicId, field);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#getDialogueTopicSubjectField");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dialogueId = dialogueId_example; // specified dialogue id
String *topicId = topicId_example; // specified topic id
String *field = field_example; // field to base64 decode and retrieve

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance getDialogueTopicSubjectFieldWith:dialogueId
    topicId:topicId
    field:field
              completionHandler: ^(byte[] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var dialogueId = dialogueId_example; // {{String}} specified dialogue id
var topicId = topicId_example; // {{String}} specified topic id
var field = field_example; // {{String}} field to base64 decode and retrieve

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDialogueTopicSubjectField(dialogueId, topicId, field, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dialogueId = dialogueId_example;  // String | specified dialogue id
            var topicId = topicId_example;  // String | specified topic id
            var field = field_example;  // String | field to base64 decode and retrieve

            try
            {
                byte[] result = apiInstance.getDialogueTopicSubjectField(dialogueId, topicId, field);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.getDialogueTopicSubjectField: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dialogueId = dialogueId_example; // String | specified dialogue id
$topicId = topicId_example; // String | specified topic id
$field = field_example; // String | field to base64 decode and retrieve

try {
    $result = $api_instance->getDialogueTopicSubjectField($dialogueId, $topicId, $field);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getDialogueTopicSubjectField: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dialogueId = dialogueId_example; # String | specified dialogue id
my $topicId = topicId_example; # String | specified topic id
my $field = field_example; # String | field to base64 decode and retrieve

eval { 
    my $result = $api_instance->getDialogueTopicSubjectField(dialogueId => $dialogueId, topicId => $topicId, field => $field);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationApi->getDialogueTopicSubjectField: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dialogueId = dialogueId_example # String | specified dialogue id
topicId = topicId_example # String | specified topic id
field = field_example # String | field to base64 decode and retrieve

try: 
    api_response = api_instance.get_dialogue_topic_subject_field(dialogueId, topicId, field)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationApi->getDialogueTopicSubjectField: %s\n" % e)

Parameters

Path parameters

Name	Description
dialogueId*	String specified dialogue id Required
topicId*	String specified topic id Required
field*	String field to base64 decode and retrieve Required

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 404 - field, topic or dialogue not found

Status: 405 - invalid field

Status: 500 - internal server error

getDialogues

Retrieve all dialogues.

/conversation/dialogues

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//conversation/dialogues"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        try {
            array[Dialogue] result = apiInstance.getDialogues();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#getDialogues");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        try {
            array[Dialogue] result = apiInstance.getDialogues();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#getDialogues");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance getDialoguesWithCompletionHandler: 
              ^(array[Dialogue] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDialogues(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();

            try
            {
                array[Dialogue] result = apiInstance.getDialogues();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.getDialogues: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();

try {
    $result = $api_instance->getDialogues();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getDialogues: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();

eval { 
    my $result = $api_instance->getDialogues();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationApi->getDialogues: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()

try: 
    api_response = api_instance.get_dialogues()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationApi->getDialogues: %s\n" % e)

Parameters

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 500 - internal server error

getInsights

Retrieve all insights. Access granted to app token for the account holder.

/conversation/insights

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//conversation/insights?dismissed="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dismissed = dismissed_example; // String | if dismissed insights should be included
        try {
            array[Insight] result = apiInstance.getInsights(dismissed);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#getInsights");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dismissed = dismissed_example; // String | if dismissed insights should be included
        try {
            array[Insight] result = apiInstance.getInsights(dismissed);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#getInsights");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dismissed = dismissed_example; // if dismissed insights should be included (optional)

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance getInsightsWith:dismissed
              completionHandler: ^(array[Insight] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var opts = { 
  'dismissed': dismissed_example // {{String}} if dismissed insights should be included
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInsights(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dismissed = dismissed_example;  // String | if dismissed insights should be included (optional) 

            try
            {
                array[Insight] result = apiInstance.getInsights(dismissed);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.getInsights: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dismissed = dismissed_example; // String | if dismissed insights should be included

try {
    $result = $api_instance->getInsights($dismissed);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getInsights: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dismissed = dismissed_example; # String | if dismissed insights should be included

eval { 
    my $result = $api_instance->getInsights(dismissed => $dismissed);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationApi->getInsights: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dismissed = dismissed_example # String | if dismissed insights should be included (optional)

try: 
    api_response = api_instance.get_insights(dismissed=dismissed)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationApi->getInsights: %s\n" % e)

Parameters

Query parameters

Name	Description
dismissed	String if dismissed insights should be included

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 500 - internal server error

getTopicAsset

Retrieve an asset associated with a topic. All transformed assets can be retrieved by anyone with access to the topic, but the original asset can only be retrieved by the author of the topic. Authorization granted to account holder app token or dialogue member contact token who is also the creator of the topic.

/conversation/dialogues/{dialogueId}/topics/{topicId}/assets/{assetId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/octet-stream"\
"//conversation/dialogues/{dialogueId}/topics/{topicId}/assets/{assetId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        String assetId = assetId_example; // String | specified asset id
        try {
            byte[] result = apiInstance.getTopicAsset(dialogueId, topicId, assetId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#getTopicAsset");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        String assetId = assetId_example; // String | specified asset id
        try {
            byte[] result = apiInstance.getTopicAsset(dialogueId, topicId, assetId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#getTopicAsset");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dialogueId = dialogueId_example; // specified dialogue id
String *topicId = topicId_example; // specified topic id
String *assetId = assetId_example; // specified asset id

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance getTopicAssetWith:dialogueId
    topicId:topicId
    assetId:assetId
              completionHandler: ^(byte[] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var dialogueId = dialogueId_example; // {{String}} specified dialogue id
var topicId = topicId_example; // {{String}} specified topic id
var assetId = assetId_example; // {{String}} specified asset id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTopicAsset(dialogueId, topicId, assetId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dialogueId = dialogueId_example;  // String | specified dialogue id
            var topicId = topicId_example;  // String | specified topic id
            var assetId = assetId_example;  // String | specified asset id

            try
            {
                byte[] result = apiInstance.getTopicAsset(dialogueId, topicId, assetId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.getTopicAsset: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dialogueId = dialogueId_example; // String | specified dialogue id
$topicId = topicId_example; // String | specified topic id
$assetId = assetId_example; // String | specified asset id

try {
    $result = $api_instance->getTopicAsset($dialogueId, $topicId, $assetId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getTopicAsset: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dialogueId = dialogueId_example; # String | specified dialogue id
my $topicId = topicId_example; # String | specified topic id
my $assetId = assetId_example; # String | specified asset id

eval { 
    my $result = $api_instance->getTopicAsset(dialogueId => $dialogueId, topicId => $topicId, assetId => $assetId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationApi->getTopicAsset: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dialogueId = dialogueId_example # String | specified dialogue id
topicId = topicId_example # String | specified topic id
assetId = assetId_example # String | specified asset id

try: 
    api_response = api_instance.get_topic_asset(dialogueId, topicId, assetId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationApi->getTopicAsset: %s\n" % e)

Parameters

Path parameters

Name	Description
dialogueId*	String specified dialogue id Required
topicId*	String specified topic id Required
assetId*	String specified asset id Required

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 404 - asset, topic or dialogue not found

Status: 500 - internal server error

getTopicAssets

Get all assets associated with the specified topic. Authorization granted to account holder app token or dialogue member contact token who has access to the topic.

/conversation/dialogues/{dialogueId}/topics/{topicId}/assets

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//conversation/dialogues/{dialogueId}/topics/{topicId}/assets"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        try {
            array[Asset] result = apiInstance.getTopicAssets(dialogueId, topicId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#getTopicAssets");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        try {
            array[Asset] result = apiInstance.getTopicAssets(dialogueId, topicId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#getTopicAssets");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dialogueId = dialogueId_example; // specified dialogue id
String *topicId = topicId_example; // specified topic id

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance getTopicAssetsWith:dialogueId
    topicId:topicId
              completionHandler: ^(array[Asset] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var dialogueId = dialogueId_example; // {{String}} specified dialogue id
var topicId = topicId_example; // {{String}} specified topic id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTopicAssets(dialogueId, topicId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dialogueId = dialogueId_example;  // String | specified dialogue id
            var topicId = topicId_example;  // String | specified topic id

            try
            {
                array[Asset] result = apiInstance.getTopicAssets(dialogueId, topicId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.getTopicAssets: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dialogueId = dialogueId_example; // String | specified dialogue id
$topicId = topicId_example; // String | specified topic id

try {
    $result = $api_instance->getTopicAssets($dialogueId, $topicId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getTopicAssets: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dialogueId = dialogueId_example; # String | specified dialogue id
my $topicId = topicId_example; # String | specified topic id

eval { 
    my $result = $api_instance->getTopicAssets(dialogueId => $dialogueId, topicId => $topicId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationApi->getTopicAssets: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dialogueId = dialogueId_example # String | specified dialogue id
topicId = topicId_example # String | specified topic id

try: 
    api_response = api_instance.get_topic_assets(dialogueId, topicId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationApi->getTopicAssets: %s\n" % e)

Parameters

Path parameters

Name	Description
dialogueId*	String specified dialogue id Required
topicId*	String specified topic id Required

Responses

Status: 201 - success

Schema

Status: 401 - permission denied

Status: 404 - topic or dialogue not found

Status: 500 - internal server error

getTopicBlock

Get the topics within a topicBlock. Only the account holder and the topic creator will retrieve pending topics. Authorization granted to account holder app token or dialogue member contact token who is also a member of the dialogue

/conversation/dialogues/{dialogueId}/topicBlocks/{blockId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//conversation/dialogues/{dialogueId}/topicBlocks/{blockId}?types="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String blockId = blockId_example; // String | specified group id
        array[String] types = ; // array[String] | limit results to topics of types
        try {
            array[Topic] result = apiInstance.getTopicBlock(dialogueId, blockId, types);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#getTopicBlock");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String blockId = blockId_example; // String | specified group id
        array[String] types = ; // array[String] | limit results to topics of types
        try {
            array[Topic] result = apiInstance.getTopicBlock(dialogueId, blockId, types);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#getTopicBlock");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dialogueId = dialogueId_example; // specified dialogue id
String *blockId = blockId_example; // specified group id
array[String] *types = ; // limit results to topics of types (optional)

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance getTopicBlockWith:dialogueId
    blockId:blockId
    types:types
              completionHandler: ^(array[Topic] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var dialogueId = dialogueId_example; // {{String}} specified dialogue id
var blockId = blockId_example; // {{String}} specified group id
var opts = { 
  'types':  // {{array[String]}} limit results to topics of types
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTopicBlock(dialogueId, blockId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dialogueId = dialogueId_example;  // String | specified dialogue id
            var blockId = blockId_example;  // String | specified group id
            var types = new array[String](); // array[String] | limit results to topics of types (optional) 

            try
            {
                array[Topic] result = apiInstance.getTopicBlock(dialogueId, blockId, types);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.getTopicBlock: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dialogueId = dialogueId_example; // String | specified dialogue id
$blockId = blockId_example; // String | specified group id
$types = ; // array[String] | limit results to topics of types

try {
    $result = $api_instance->getTopicBlock($dialogueId, $blockId, $types);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getTopicBlock: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dialogueId = dialogueId_example; # String | specified dialogue id
my $blockId = blockId_example; # String | specified group id
my $types = []; # array[String] | limit results to topics of types

eval { 
    my $result = $api_instance->getTopicBlock(dialogueId => $dialogueId, blockId => $blockId, types => $types);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationApi->getTopicBlock: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dialogueId = dialogueId_example # String | specified dialogue id
blockId = blockId_example # String | specified group id
types =  # array[String] | limit results to topics of types (optional)

try: 
    api_response = api_instance.get_topic_block(dialogueId, blockId, types=types)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationApi->getTopicBlock: %s\n" % e)

Parameters

Path parameters

Name	Description
dialogueId*	String specified dialogue id Required
blockId*	String specified group id Required

Query parameters

Name	Description
types	array[String] limit results to topics of types

Responses

Status: 200 - successful operation

Schema

Status: 401 - permission denied

Status: 404 - block or dialogue not found

Status: 500 - internal server error

getTopicBlockView

Get a view of the topicBlocks within a dialogue. Authorization granted to account holder app token or dialogue member contact token who is also a member of the dialogue

/conversation/dialogues/{dialogueId}/topicBlocks/view

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//conversation/dialogues/{dialogueId}/topicBlocks/view?types="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        array[String] types = ; // array[String] | limit results to topics of types
        try {
            array[inline_response_200_1] result = apiInstance.getTopicBlockView(dialogueId, types);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#getTopicBlockView");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        array[String] types = ; // array[String] | limit results to topics of types
        try {
            array[inline_response_200_1] result = apiInstance.getTopicBlockView(dialogueId, types);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#getTopicBlockView");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dialogueId = dialogueId_example; // specified dialogue id
array[String] *types = ; // limit results to topics of types (optional)

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance getTopicBlockViewWith:dialogueId
    types:types
              completionHandler: ^(array[inline_response_200_1] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var dialogueId = dialogueId_example; // {{String}} specified dialogue id
var opts = { 
  'types':  // {{array[String]}} limit results to topics of types
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTopicBlockView(dialogueId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dialogueId = dialogueId_example;  // String | specified dialogue id
            var types = new array[String](); // array[String] | limit results to topics of types (optional) 

            try
            {
                array[inline_response_200_1] result = apiInstance.getTopicBlockView(dialogueId, types);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.getTopicBlockView: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dialogueId = dialogueId_example; // String | specified dialogue id
$types = ; // array[String] | limit results to topics of types

try {
    $result = $api_instance->getTopicBlockView($dialogueId, $types);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getTopicBlockView: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dialogueId = dialogueId_example; # String | specified dialogue id
my $types = []; # array[String] | limit results to topics of types

eval { 
    my $result = $api_instance->getTopicBlockView(dialogueId => $dialogueId, types => $types);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationApi->getTopicBlockView: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dialogueId = dialogueId_example # String | specified dialogue id
types =  # array[String] | limit results to topics of types (optional)

try: 
    api_response = api_instance.get_topic_block_view(dialogueId, types=types)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationApi->getTopicBlockView: %s\n" % e)

Parameters

Path parameters

Name	Description
dialogueId*	String specified dialogue id Required

Query parameters

Name	Description
types	array[String] limit results to topics of types

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 404 - dialogue not found

Status: 500 - internal server error

getTopicTag

Retrieve specified tag on the topic. Authorization granted to account holder app token or dialogue member contact token who has access to the topic.

/conversation/dialogues/{dialogueId}/topics/{topicId}/tags/{tagId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//conversation/dialogues/{dialogueId}/topics/{topicId}/tags/{tagId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        String tagId = tagId_example; // String | specified tag id
        try {
            Tag result = apiInstance.getTopicTag(dialogueId, topicId, tagId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#getTopicTag");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        String tagId = tagId_example; // String | specified tag id
        try {
            Tag result = apiInstance.getTopicTag(dialogueId, topicId, tagId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#getTopicTag");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dialogueId = dialogueId_example; // specified dialogue id
String *topicId = topicId_example; // specified topic id
String *tagId = tagId_example; // specified tag id

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance getTopicTagWith:dialogueId
    topicId:topicId
    tagId:tagId
              completionHandler: ^(Tag output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var dialogueId = dialogueId_example; // {{String}} specified dialogue id
var topicId = topicId_example; // {{String}} specified topic id
var tagId = tagId_example; // {{String}} specified tag id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTopicTag(dialogueId, topicId, tagId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dialogueId = dialogueId_example;  // String | specified dialogue id
            var topicId = topicId_example;  // String | specified topic id
            var tagId = tagId_example;  // String | specified tag id

            try
            {
                Tag result = apiInstance.getTopicTag(dialogueId, topicId, tagId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.getTopicTag: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dialogueId = dialogueId_example; // String | specified dialogue id
$topicId = topicId_example; // String | specified topic id
$tagId = tagId_example; // String | specified tag id

try {
    $result = $api_instance->getTopicTag($dialogueId, $topicId, $tagId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getTopicTag: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dialogueId = dialogueId_example; # String | specified dialogue id
my $topicId = topicId_example; # String | specified topic id
my $tagId = tagId_example; # String | specified tag id

eval { 
    my $result = $api_instance->getTopicTag(dialogueId => $dialogueId, topicId => $topicId, tagId => $tagId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationApi->getTopicTag: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dialogueId = dialogueId_example # String | specified dialogue id
topicId = topicId_example # String | specified topic id
tagId = tagId_example # String | specified tag id

try: 
    api_response = api_instance.get_topic_tag(dialogueId, topicId, tagId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationApi->getTopicTag: %s\n" % e)

Parameters

Path parameters

Name	Description
dialogueId*	String specified dialogue id Required
topicId*	String specified topic id Required
tagId*	String specified tag id Required

Responses

Status: 201 - success

Schema

Status: 401 - permission denied

Status: 404 - tag, topic, or dialogue not found

Status: 500 - internal server error

getTopicTagBlockView

Get a view of all of all tagBlocks. Authorization granted to account holder app token or dialogue member contact token who has access to the topic.

/conversation/dialogues/{dialogueId}/topics/{topicId}/tagBlocks/view

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//conversation/dialogues/{dialogueId}/topics/{topicId}/tagBlocks/view?types="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        array[String] types = ; // array[String] | limit results to articles of types
        try {
            array[inline_response_200_1] result = apiInstance.getTopicTagBlockView(dialogueId, topicId, types);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#getTopicTagBlockView");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        array[String] types = ; // array[String] | limit results to articles of types
        try {
            array[inline_response_200_1] result = apiInstance.getTopicTagBlockView(dialogueId, topicId, types);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#getTopicTagBlockView");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dialogueId = dialogueId_example; // specified dialogue id
String *topicId = topicId_example; // specified topic id
array[String] *types = ; // limit results to articles of types (optional)

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance getTopicTagBlockViewWith:dialogueId
    topicId:topicId
    types:types
              completionHandler: ^(array[inline_response_200_1] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var dialogueId = dialogueId_example; // {{String}} specified dialogue id
var topicId = topicId_example; // {{String}} specified topic id
var opts = { 
  'types':  // {{array[String]}} limit results to articles of types
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTopicTagBlockView(dialogueId, topicId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dialogueId = dialogueId_example;  // String | specified dialogue id
            var topicId = topicId_example;  // String | specified topic id
            var types = new array[String](); // array[String] | limit results to articles of types (optional) 

            try
            {
                array[inline_response_200_1] result = apiInstance.getTopicTagBlockView(dialogueId, topicId, types);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.getTopicTagBlockView: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dialogueId = dialogueId_example; // String | specified dialogue id
$topicId = topicId_example; // String | specified topic id
$types = ; // array[String] | limit results to articles of types

try {
    $result = $api_instance->getTopicTagBlockView($dialogueId, $topicId, $types);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getTopicTagBlockView: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dialogueId = dialogueId_example; # String | specified dialogue id
my $topicId = topicId_example; # String | specified topic id
my $types = []; # array[String] | limit results to articles of types

eval { 
    my $result = $api_instance->getTopicTagBlockView(dialogueId => $dialogueId, topicId => $topicId, types => $types);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationApi->getTopicTagBlockView: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dialogueId = dialogueId_example # String | specified dialogue id
topicId = topicId_example # String | specified topic id
types =  # array[String] | limit results to articles of types (optional)

try: 
    api_response = api_instance.get_topic_tag_block_view(dialogueId, topicId, types=types)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationApi->getTopicTagBlockView: %s\n" % e)

Parameters

Path parameters

Name	Description
dialogueId*	String specified dialogue id Required
topicId*	String specified topic id Required

Query parameters

Name	Description
types	array[String] limit results to articles of types

Responses

Status: 200 - successful operation

Schema

Status: 401 - permission denied

Status: 404 - topic or dialogue not found

Status: 500 - internal server error

getTopicTagSubjectField

Base64 decode and retrieve specified field of tag subject on the topic. Authorization granted to account holder app token or dialogue member contact token who has access to the topic.

/conversation/dialogues/{dialogueId}/topics/{topicId}/tags/{tagId}/subject/{field}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//conversation/dialogues/{dialogueId}/topics/{topicId}/tags/{tagId}/subject/{field}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        String tagId = tagId_example; // String | specified tag id
        String field = field_example; // String | field to base64 decode and download
        try {
            Tag result = apiInstance.getTopicTagSubjectField(dialogueId, topicId, tagId, field);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#getTopicTagSubjectField");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        String tagId = tagId_example; // String | specified tag id
        String field = field_example; // String | field to base64 decode and download
        try {
            Tag result = apiInstance.getTopicTagSubjectField(dialogueId, topicId, tagId, field);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#getTopicTagSubjectField");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dialogueId = dialogueId_example; // specified dialogue id
String *topicId = topicId_example; // specified topic id
String *tagId = tagId_example; // specified tag id
String *field = field_example; // field to base64 decode and download

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance getTopicTagSubjectFieldWith:dialogueId
    topicId:topicId
    tagId:tagId
    field:field
              completionHandler: ^(Tag output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var dialogueId = dialogueId_example; // {{String}} specified dialogue id
var topicId = topicId_example; // {{String}} specified topic id
var tagId = tagId_example; // {{String}} specified tag id
var field = field_example; // {{String}} field to base64 decode and download

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTopicTagSubjectField(dialogueId, topicId, tagId, field, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dialogueId = dialogueId_example;  // String | specified dialogue id
            var topicId = topicId_example;  // String | specified topic id
            var tagId = tagId_example;  // String | specified tag id
            var field = field_example;  // String | field to base64 decode and download

            try
            {
                Tag result = apiInstance.getTopicTagSubjectField(dialogueId, topicId, tagId, field);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.getTopicTagSubjectField: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dialogueId = dialogueId_example; // String | specified dialogue id
$topicId = topicId_example; // String | specified topic id
$tagId = tagId_example; // String | specified tag id
$field = field_example; // String | field to base64 decode and download

try {
    $result = $api_instance->getTopicTagSubjectField($dialogueId, $topicId, $tagId, $field);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getTopicTagSubjectField: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dialogueId = dialogueId_example; # String | specified dialogue id
my $topicId = topicId_example; # String | specified topic id
my $tagId = tagId_example; # String | specified tag id
my $field = field_example; # String | field to base64 decode and download

eval { 
    my $result = $api_instance->getTopicTagSubjectField(dialogueId => $dialogueId, topicId => $topicId, tagId => $tagId, field => $field);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationApi->getTopicTagSubjectField: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dialogueId = dialogueId_example # String | specified dialogue id
topicId = topicId_example # String | specified topic id
tagId = tagId_example # String | specified tag id
field = field_example # String | field to base64 decode and download

try: 
    api_response = api_instance.get_topic_tag_subject_field(dialogueId, topicId, tagId, field)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationApi->getTopicTagSubjectField: %s\n" % e)

Parameters

Path parameters

Name	Description
dialogueId*	String specified dialogue id Required
topicId*	String specified topic id Required
tagId*	String specified tag id Required
field*	String field to base64 decode and download Required

Responses

Status: 201 - success

Schema

Status: 401 - permission denied

Status: 404 - field, tag, topic, or dialogue not found

Status: 405 - invalid field

Status: 500 - internal server error

getTopicTagView

Get a view of all of the tags within a block. Authorization granted to account holder app token or dialogue member contact token who has access to the topic.

/conversation/dialogues/{dialogueId}/topics/{topicId}/tagBlocks/{blockId}/view

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//conversation/dialogues/{dialogueId}/topics/{topicId}/tagBlocks/{blockId}/view?types="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        String blockId = blockId_example; // String | specified block id
        array[String] types = ; // array[String] | limit results to tags of types
        try {
            array[inline_response_200_1] result = apiInstance.getTopicTagView(dialogueId, topicId, blockId, types);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#getTopicTagView");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        String blockId = blockId_example; // String | specified block id
        array[String] types = ; // array[String] | limit results to tags of types
        try {
            array[inline_response_200_1] result = apiInstance.getTopicTagView(dialogueId, topicId, blockId, types);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#getTopicTagView");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dialogueId = dialogueId_example; // specified dialogue id
String *topicId = topicId_example; // specified topic id
String *blockId = blockId_example; // specified block id
array[String] *types = ; // limit results to tags of types (optional)

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance getTopicTagViewWith:dialogueId
    topicId:topicId
    blockId:blockId
    types:types
              completionHandler: ^(array[inline_response_200_1] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var dialogueId = dialogueId_example; // {{String}} specified dialogue id
var topicId = topicId_example; // {{String}} specified topic id
var blockId = blockId_example; // {{String}} specified block id
var opts = { 
  'types':  // {{array[String]}} limit results to tags of types
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTopicTagView(dialogueId, topicId, blockId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dialogueId = dialogueId_example;  // String | specified dialogue id
            var topicId = topicId_example;  // String | specified topic id
            var blockId = blockId_example;  // String | specified block id
            var types = new array[String](); // array[String] | limit results to tags of types (optional) 

            try
            {
                array[inline_response_200_1] result = apiInstance.getTopicTagView(dialogueId, topicId, blockId, types);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.getTopicTagView: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dialogueId = dialogueId_example; // String | specified dialogue id
$topicId = topicId_example; // String | specified topic id
$blockId = blockId_example; // String | specified block id
$types = ; // array[String] | limit results to tags of types

try {
    $result = $api_instance->getTopicTagView($dialogueId, $topicId, $blockId, $types);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getTopicTagView: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dialogueId = dialogueId_example; # String | specified dialogue id
my $topicId = topicId_example; # String | specified topic id
my $blockId = blockId_example; # String | specified block id
my $types = []; # array[String] | limit results to tags of types

eval { 
    my $result = $api_instance->getTopicTagView(dialogueId => $dialogueId, topicId => $topicId, blockId => $blockId, types => $types);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationApi->getTopicTagView: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dialogueId = dialogueId_example # String | specified dialogue id
topicId = topicId_example # String | specified topic id
blockId = blockId_example # String | specified block id
types =  # array[String] | limit results to tags of types (optional)

try: 
    api_response = api_instance.get_topic_tag_view(dialogueId, topicId, blockId, types=types)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationApi->getTopicTagView: %s\n" % e)

Parameters

Path parameters

Name	Description
dialogueId*	String specified dialogue id Required
topicId*	String specified topic id Required
blockId*	String specified block id Required

Query parameters

Name	Description
types	array[String] limit results to tags of types

Responses

Status: 200 - successful operation

Schema

Status: 401 - permission denied

Status: 404 - block, topic or dialogue not found

Status: 500 - internal server error

getTopicTags

Get all of the tags within a tag block. Authorization granted to account holder app token or dialogue member contact token who has access to the topic.

/conversation/dialogues/{dialogueId}/topics/{topicId}/tagBlocks/{blockId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//conversation/dialogues/{dialogueId}/topics/{topicId}/tagBlocks/{blockId}?types="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        String blockId = blockId_example; // String | specified block id
        array[String] types = ; // array[String] | limit results to tags of types
        try {
            array[Tag] result = apiInstance.getTopicTags(dialogueId, topicId, blockId, types);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#getTopicTags");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        String blockId = blockId_example; // String | specified block id
        array[String] types = ; // array[String] | limit results to tags of types
        try {
            array[Tag] result = apiInstance.getTopicTags(dialogueId, topicId, blockId, types);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#getTopicTags");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dialogueId = dialogueId_example; // specified dialogue id
String *topicId = topicId_example; // specified topic id
String *blockId = blockId_example; // specified block id
array[String] *types = ; // limit results to tags of types (optional)

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance getTopicTagsWith:dialogueId
    topicId:topicId
    blockId:blockId
    types:types
              completionHandler: ^(array[Tag] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var dialogueId = dialogueId_example; // {{String}} specified dialogue id
var topicId = topicId_example; // {{String}} specified topic id
var blockId = blockId_example; // {{String}} specified block id
var opts = { 
  'types':  // {{array[String]}} limit results to tags of types
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTopicTags(dialogueId, topicId, blockId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dialogueId = dialogueId_example;  // String | specified dialogue id
            var topicId = topicId_example;  // String | specified topic id
            var blockId = blockId_example;  // String | specified block id
            var types = new array[String](); // array[String] | limit results to tags of types (optional) 

            try
            {
                array[Tag] result = apiInstance.getTopicTags(dialogueId, topicId, blockId, types);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.getTopicTags: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dialogueId = dialogueId_example; // String | specified dialogue id
$topicId = topicId_example; // String | specified topic id
$blockId = blockId_example; // String | specified block id
$types = ; // array[String] | limit results to tags of types

try {
    $result = $api_instance->getTopicTags($dialogueId, $topicId, $blockId, $types);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getTopicTags: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dialogueId = dialogueId_example; # String | specified dialogue id
my $topicId = topicId_example; # String | specified topic id
my $blockId = blockId_example; # String | specified block id
my $types = []; # array[String] | limit results to tags of types

eval { 
    my $result = $api_instance->getTopicTags(dialogueId => $dialogueId, topicId => $topicId, blockId => $blockId, types => $types);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationApi->getTopicTags: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dialogueId = dialogueId_example # String | specified dialogue id
topicId = topicId_example # String | specified topic id
blockId = blockId_example # String | specified block id
types =  # array[String] | limit results to tags of types (optional)

try: 
    api_response = api_instance.get_topic_tags(dialogueId, topicId, blockId, types=types)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationApi->getTopicTags: %s\n" % e)

Parameters

Path parameters

Name	Description
dialogueId*	String specified dialogue id Required
topicId*	String specified topic id Required
blockId*	String specified block id Required

Query parameters

Name	Description
types	array[String] limit results to tags of types

Responses

Status: 200 - successful operation

Schema

Status: 401 - permission denied

Status: 404 - block, topic, or dialogue not found

Status: 500 - internal server error

getTopicViews

Get a view of the topics within a topicBlock. Authorization granted to account holder app token or dialogue member contact token who is also a member of the dialogue.

/conversation/dialogues/{dialogueId}/topicBlocks/{blockId}/view

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//conversation/dialogues/{dialogueId}/topicBlocks/{blockId}/view?types="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String blockId = blockId_example; // String | specified group id
        array[String] types = ; // array[String] | limit results to topics of types
        try {
            array[inline_response_200_1] result = apiInstance.getTopicViews(dialogueId, blockId, types);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#getTopicViews");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String blockId = blockId_example; // String | specified group id
        array[String] types = ; // array[String] | limit results to topics of types
        try {
            array[inline_response_200_1] result = apiInstance.getTopicViews(dialogueId, blockId, types);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#getTopicViews");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dialogueId = dialogueId_example; // specified dialogue id
String *blockId = blockId_example; // specified group id
array[String] *types = ; // limit results to topics of types (optional)

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance getTopicViewsWith:dialogueId
    blockId:blockId
    types:types
              completionHandler: ^(array[inline_response_200_1] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var dialogueId = dialogueId_example; // {{String}} specified dialogue id
var blockId = blockId_example; // {{String}} specified group id
var opts = { 
  'types':  // {{array[String]}} limit results to topics of types
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTopicViews(dialogueId, blockId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dialogueId = dialogueId_example;  // String | specified dialogue id
            var blockId = blockId_example;  // String | specified group id
            var types = new array[String](); // array[String] | limit results to topics of types (optional) 

            try
            {
                array[inline_response_200_1] result = apiInstance.getTopicViews(dialogueId, blockId, types);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.getTopicViews: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dialogueId = dialogueId_example; // String | specified dialogue id
$blockId = blockId_example; // String | specified group id
$types = ; // array[String] | limit results to topics of types

try {
    $result = $api_instance->getTopicViews($dialogueId, $blockId, $types);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->getTopicViews: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dialogueId = dialogueId_example; # String | specified dialogue id
my $blockId = blockId_example; # String | specified group id
my $types = []; # array[String] | limit results to topics of types

eval { 
    my $result = $api_instance->getTopicViews(dialogueId => $dialogueId, blockId => $blockId, types => $types);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationApi->getTopicViews: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dialogueId = dialogueId_example # String | specified dialogue id
blockId = blockId_example # String | specified group id
types =  # array[String] | limit results to topics of types (optional)

try: 
    api_response = api_instance.get_topic_views(dialogueId, blockId, types=types)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationApi->getTopicViews: %s\n" % e)

Parameters

Path parameters

Name	Description
dialogueId*	String specified dialogue id Required
blockId*	String specified group id Required

Query parameters

Name	Description
types	array[String] limit results to topics of types

Responses

Status: 200 - successful operation

Schema

Status: 401 - permission denied

Status: 404 - block or dialogue not found

Status: 500 - internal server error

removeDialogue

Remove specified dialogue. This endpoint will authomatically invoke the delete insight endpoint on all of the contacts' nodes. Access is granted to an app token for the account holder.

/conversation/dialogues/{dialogueId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
"//conversation/dialogues/{dialogueId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        try {
            apiInstance.removeDialogue(dialogueId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#removeDialogue");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        try {
            apiInstance.removeDialogue(dialogueId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#removeDialogue");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dialogueId = dialogueId_example; // specified dialogue id

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance removeDialogueWith:dialogueId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var dialogueId = dialogueId_example; // {{String}} specified dialogue id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeDialogue(dialogueId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dialogueId = dialogueId_example;  // String | specified dialogue id

            try
            {
                apiInstance.removeDialogue(dialogueId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.removeDialogue: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dialogueId = dialogueId_example; // String | specified dialogue id

try {
    $api_instance->removeDialogue($dialogueId);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->removeDialogue: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dialogueId = dialogueId_example; # String | specified dialogue id

eval { 
    $api_instance->removeDialogue(dialogueId => $dialogueId);
};
if ($@) {
    warn "Exception when calling ConversationApi->removeDialogue: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dialogueId = dialogueId_example # String | specified dialogue id

try: 
    api_instance.remove_dialogue(dialogueId)
except ApiException as e:
    print("Exception when calling ConversationApi->removeDialogue: %s\n" % e)

Parameters

Path parameters

Name	Description
dialogueId*	String specified dialogue id Required

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 404 - dialogue not found

Status: 500 - internal server error

removeDialogueInsight

Remove an insight from a dialogue. This endpoint will authomatically invoke the delete insight endpoint on the contact's node. Authorization is granted to the app token of the accoun holder.

/conversation/dialogues/{dialogueId}/cards/{cardId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
"//conversation/dialogues/{dialogueId}/cards/{cardId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String cardId = cardId_example; // String | specified contact id
        try {
            apiInstance.removeDialogueInsight(dialogueId, cardId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#removeDialogueInsight");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String cardId = cardId_example; // String | specified contact id
        try {
            apiInstance.removeDialogueInsight(dialogueId, cardId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#removeDialogueInsight");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dialogueId = dialogueId_example; // specified dialogue id
String *cardId = cardId_example; // specified contact id

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance removeDialogueInsightWith:dialogueId
    cardId:cardId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var dialogueId = dialogueId_example; // {{String}} specified dialogue id
var cardId = cardId_example; // {{String}} specified contact id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeDialogueInsight(dialogueId, cardId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dialogueId = dialogueId_example;  // String | specified dialogue id
            var cardId = cardId_example;  // String | specified contact id

            try
            {
                apiInstance.removeDialogueInsight(dialogueId, cardId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.removeDialogueInsight: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dialogueId = dialogueId_example; // String | specified dialogue id
$cardId = cardId_example; // String | specified contact id

try {
    $api_instance->removeDialogueInsight($dialogueId, $cardId);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->removeDialogueInsight: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dialogueId = dialogueId_example; # String | specified dialogue id
my $cardId = cardId_example; # String | specified contact id

eval { 
    $api_instance->removeDialogueInsight(dialogueId => $dialogueId, cardId => $cardId);
};
if ($@) {
    warn "Exception when calling ConversationApi->removeDialogueInsight: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dialogueId = dialogueId_example # String | specified dialogue id
cardId = cardId_example # String | specified contact id

try: 
    api_instance.remove_dialogue_insight(dialogueId, cardId)
except ApiException as e:
    print("Exception when calling ConversationApi->removeDialogueInsight: %s\n" % e)

Parameters

Path parameters

Name	Description
dialogueId*	String specified dialogue id Required
cardId*	String specified contact id Required

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 404 - cardId or dialogue not found

Status: 500 - internal server error

removeDialogueTopic

Remove a topic from a dialogue. Authorization granted to account holder app token or dialogue member contact token who is either the topic createor or the account holder.

/conversation/dialogues/{dialogueId}/topics/{topicId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
"//conversation/dialogues/{dialogueId}/topics/{topicId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        try {
            apiInstance.removeDialogueTopic(dialogueId, topicId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#removeDialogueTopic");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        try {
            apiInstance.removeDialogueTopic(dialogueId, topicId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#removeDialogueTopic");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dialogueId = dialogueId_example; // specified dialogue id
String *topicId = topicId_example; // specified topic id

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance removeDialogueTopicWith:dialogueId
    topicId:topicId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var dialogueId = dialogueId_example; // {{String}} specified dialogue id
var topicId = topicId_example; // {{String}} specified topic id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeDialogueTopic(dialogueId, topicId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dialogueId = dialogueId_example;  // String | specified dialogue id
            var topicId = topicId_example;  // String | specified topic id

            try
            {
                apiInstance.removeDialogueTopic(dialogueId, topicId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.removeDialogueTopic: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dialogueId = dialogueId_example; // String | specified dialogue id
$topicId = topicId_example; // String | specified topic id

try {
    $api_instance->removeDialogueTopic($dialogueId, $topicId);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->removeDialogueTopic: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dialogueId = dialogueId_example; # String | specified dialogue id
my $topicId = topicId_example; # String | specified topic id

eval { 
    $api_instance->removeDialogueTopic(dialogueId => $dialogueId, topicId => $topicId);
};
if ($@) {
    warn "Exception when calling ConversationApi->removeDialogueTopic: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dialogueId = dialogueId_example # String | specified dialogue id
topicId = topicId_example # String | specified topic id

try: 
    api_instance.remove_dialogue_topic(dialogueId, topicId)
except ApiException as e:
    print("Exception when calling ConversationApi->removeDialogueTopic: %s\n" % e)

Parameters

Path parameters

Name	Description
dialogueId*	String specified dialogue id Required
topicId*	String specified topic id Required

Responses

Status: 200 - successful operation

Status: 401 - permission denied

Status: 403 - inactive dialogue

Status: 404 - topic or dilaogue not found

Status: 500 - internal server error

removeTopicAsset

Remove and delete an asset associated with a topic. Authorization granted to account holder app token or dialogue member contact token who is also the creator of the topic.

/conversation/dialogues/{dialogueId}/topics/{topicId}/assets/{assetId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
"//conversation/dialogues/{dialogueId}/topics/{topicId}/assets/{assetId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        String assetId = assetId_example; // String | specified asset id
        try {
            apiInstance.removeTopicAsset(dialogueId, topicId, assetId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#removeTopicAsset");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        String assetId = assetId_example; // String | specified asset id
        try {
            apiInstance.removeTopicAsset(dialogueId, topicId, assetId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#removeTopicAsset");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dialogueId = dialogueId_example; // specified dialogue id
String *topicId = topicId_example; // specified topic id
String *assetId = assetId_example; // specified asset id

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance removeTopicAssetWith:dialogueId
    topicId:topicId
    assetId:assetId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var dialogueId = dialogueId_example; // {{String}} specified dialogue id
var topicId = topicId_example; // {{String}} specified topic id
var assetId = assetId_example; // {{String}} specified asset id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeTopicAsset(dialogueId, topicId, assetId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dialogueId = dialogueId_example;  // String | specified dialogue id
            var topicId = topicId_example;  // String | specified topic id
            var assetId = assetId_example;  // String | specified asset id

            try
            {
                apiInstance.removeTopicAsset(dialogueId, topicId, assetId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.removeTopicAsset: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dialogueId = dialogueId_example; // String | specified dialogue id
$topicId = topicId_example; // String | specified topic id
$assetId = assetId_example; // String | specified asset id

try {
    $api_instance->removeTopicAsset($dialogueId, $topicId, $assetId);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->removeTopicAsset: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dialogueId = dialogueId_example; # String | specified dialogue id
my $topicId = topicId_example; # String | specified topic id
my $assetId = assetId_example; # String | specified asset id

eval { 
    $api_instance->removeTopicAsset(dialogueId => $dialogueId, topicId => $topicId, assetId => $assetId);
};
if ($@) {
    warn "Exception when calling ConversationApi->removeTopicAsset: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dialogueId = dialogueId_example # String | specified dialogue id
topicId = topicId_example # String | specified topic id
assetId = assetId_example # String | specified asset id

try: 
    api_instance.remove_topic_asset(dialogueId, topicId, assetId)
except ApiException as e:
    print("Exception when calling ConversationApi->removeTopicAsset: %s\n" % e)

Parameters

Path parameters

Name	Description
dialogueId*	String specified dialogue id Required
topicId*	String specified topic id Required
assetId*	String specified asset id Required

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 403 - inactive dialogue

Status: 404 - asset, topic or dialogue not found

Status: 500 - internal server error

removeTopicTag

Remove specified tag from the topic. Authorization granted to account holder app token or dialogue member contact token who has access to the topic.

/conversation/dialogues/{dialogueId}/topics/{topicId}/tags/{tagId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
"//conversation/dialogues/{dialogueId}/topics/{topicId}/tags/{tagId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        String tagId = tagId_example; // String | specified tag id
        try {
            apiInstance.removeTopicTag(dialogueId, topicId, tagId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#removeTopicTag");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        String tagId = tagId_example; // String | specified tag id
        try {
            apiInstance.removeTopicTag(dialogueId, topicId, tagId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#removeTopicTag");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dialogueId = dialogueId_example; // specified dialogue id
String *topicId = topicId_example; // specified topic id
String *tagId = tagId_example; // specified tag id

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance removeTopicTagWith:dialogueId
    topicId:topicId
    tagId:tagId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var dialogueId = dialogueId_example; // {{String}} specified dialogue id
var topicId = topicId_example; // {{String}} specified topic id
var tagId = tagId_example; // {{String}} specified tag id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeTopicTag(dialogueId, topicId, tagId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dialogueId = dialogueId_example;  // String | specified dialogue id
            var topicId = topicId_example;  // String | specified topic id
            var tagId = tagId_example;  // String | specified tag id

            try
            {
                apiInstance.removeTopicTag(dialogueId, topicId, tagId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.removeTopicTag: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dialogueId = dialogueId_example; // String | specified dialogue id
$topicId = topicId_example; // String | specified topic id
$tagId = tagId_example; // String | specified tag id

try {
    $api_instance->removeTopicTag($dialogueId, $topicId, $tagId);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->removeTopicTag: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dialogueId = dialogueId_example; # String | specified dialogue id
my $topicId = topicId_example; # String | specified topic id
my $tagId = tagId_example; # String | specified tag id

eval { 
    $api_instance->removeTopicTag(dialogueId => $dialogueId, topicId => $topicId, tagId => $tagId);
};
if ($@) {
    warn "Exception when calling ConversationApi->removeTopicTag: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dialogueId = dialogueId_example # String | specified dialogue id
topicId = topicId_example # String | specified topic id
tagId = tagId_example # String | specified tag id

try: 
    api_instance.remove_topic_tag(dialogueId, topicId, tagId)
except ApiException as e:
    print("Exception when calling ConversationApi->removeTopicTag: %s\n" % e)

Parameters

Path parameters

Name	Description
dialogueId*	String specified dialogue id Required
topicId*	String specified topic id Required
tagId*	String specified tag id Required

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 403 - inactive dialogue

Status: 404 - tag, topic, or dialogue not found

Status: 500 - internal server error

setDialogueActive

Set active state of dialogue. If a dialogue is inactive any update to the topics will fail. Authorization is granted to an app token of the account holder.

/conversation/dialogues/{dialogueId}/active

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Content-Type: application/json"\
"//conversation/dialogues/{dialogueId}/active"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        Boolean body = ; // Boolean | 
        try {
            apiInstance.setDialogueActive(dialogueId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#setDialogueActive");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        Boolean body = ; // Boolean | 
        try {
            apiInstance.setDialogueActive(dialogueId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#setDialogueActive");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dialogueId = dialogueId_example; // specified dialogue id
Boolean *body = ; //  (optional)

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance setDialogueActiveWith:dialogueId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var dialogueId = dialogueId_example; // {{String}} specified dialogue id
var opts = { 
  'body':  // {{Boolean}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setDialogueActive(dialogueId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dialogueId = dialogueId_example;  // String | specified dialogue id
            var body = new Boolean(); // Boolean |  (optional) 

            try
            {
                apiInstance.setDialogueActive(dialogueId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.setDialogueActive: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dialogueId = dialogueId_example; // String | specified dialogue id
$body = ; // Boolean | 

try {
    $api_instance->setDialogueActive($dialogueId, $body);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->setDialogueActive: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dialogueId = dialogueId_example; # String | specified dialogue id
my $body = WWW::SwaggerClient::Object::Boolean->new(); # Boolean | 

eval { 
    $api_instance->setDialogueActive(dialogueId => $dialogueId, body => $body);
};
if ($@) {
    warn "Exception when calling ConversationApi->setDialogueActive: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dialogueId = dialogueId_example # String | specified dialogue id
body =  # Boolean |  (optional)

try: 
    api_instance.set_dialogue_active(dialogueId, body=body)
except ApiException as e:
    print("Exception when calling ConversationApi->setDialogueActive: %s\n" % e)

Parameters

Path parameters

Name	Description
dialogueId*	String specified dialogue id Required

Body parameters

Name	Description
body

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 404 - dialogue not found

Status: 500 - internal server error

setDialogueInsightStatus

Set active status for contact on the host node. Access is granted to a contact token for an account with the specified contact

/conversation/dialogues/{dialogueId}/status

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Content-Type: application/json"\
"//conversation/dialogues/{dialogueId}/status"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String body = ; // String | 
        try {
            apiInstance.setDialogueInsightStatus(dialogueId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#setDialogueInsightStatus");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String body = ; // String | 
        try {
            apiInstance.setDialogueInsightStatus(dialogueId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#setDialogueInsightStatus");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dialogueId = dialogueId_example; // specified dialogue id
String *body = ; //  (optional)

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance setDialogueInsightStatusWith:dialogueId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var dialogueId = dialogueId_example; // {{String}} specified dialogue id
var opts = { 
  'body':  // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setDialogueInsightStatus(dialogueId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dialogueId = dialogueId_example;  // String | specified dialogue id
            var body = new String(); // String |  (optional) 

            try
            {
                apiInstance.setDialogueInsightStatus(dialogueId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.setDialogueInsightStatus: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dialogueId = dialogueId_example; // String | specified dialogue id
$body = ; // String | 

try {
    $api_instance->setDialogueInsightStatus($dialogueId, $body);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->setDialogueInsightStatus: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dialogueId = dialogueId_example; # String | specified dialogue id
my $body = WWW::SwaggerClient::Object::String->new(); # String | 

eval { 
    $api_instance->setDialogueInsightStatus(dialogueId => $dialogueId, body => $body);
};
if ($@) {
    warn "Exception when calling ConversationApi->setDialogueInsightStatus: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dialogueId = dialogueId_example # String | specified dialogue id
body =  # String |  (optional)

try: 
    api_instance.set_dialogue_insight_status(dialogueId, body=body)
except ApiException as e:
    print("Exception when calling ConversationApi->setDialogueInsightStatus: %s\n" % e)

Parameters

Path parameters

Name	Description
dialogueId*	String specified dialogue id Required

Body parameters

Name	Description
body

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 404 - dialogue not found

Status: 500 - internal server error

setDialogueSubject

Set the subject for a dialogue. Authorization granted the an app token for the account holder.

/conversation/dialogues/{dialogueId}/subject

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Content-Type: application/json"\
"//conversation/dialogues/{dialogueId}/subject"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        DialogueId_subject_body body = ; // DialogueId_subject_body | 
        try {
            apiInstance.setDialogueSubject(dialogueId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#setDialogueSubject");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        DialogueId_subject_body body = ; // DialogueId_subject_body | 
        try {
            apiInstance.setDialogueSubject(dialogueId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#setDialogueSubject");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dialogueId = dialogueId_example; // specified dialogue id
DialogueId_subject_body *body = ; //  (optional)

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance setDialogueSubjectWith:dialogueId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var dialogueId = dialogueId_example; // {{String}} specified dialogue id
var opts = { 
  'body':  // {{DialogueId_subject_body}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setDialogueSubject(dialogueId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dialogueId = dialogueId_example;  // String | specified dialogue id
            var body = new DialogueId_subject_body(); // DialogueId_subject_body |  (optional) 

            try
            {
                apiInstance.setDialogueSubject(dialogueId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.setDialogueSubject: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dialogueId = dialogueId_example; // String | specified dialogue id
$body = ; // DialogueId_subject_body | 

try {
    $api_instance->setDialogueSubject($dialogueId, $body);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->setDialogueSubject: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dialogueId = dialogueId_example; # String | specified dialogue id
my $body = WWW::SwaggerClient::Object::DialogueId_subject_body->new(); # DialogueId_subject_body | 

eval { 
    $api_instance->setDialogueSubject(dialogueId => $dialogueId, body => $body);
};
if ($@) {
    warn "Exception when calling ConversationApi->setDialogueSubject: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dialogueId = dialogueId_example # String | specified dialogue id
body =  # DialogueId_subject_body |  (optional)

try: 
    api_instance.set_dialogue_subject(dialogueId, body=body)
except ApiException as e:
    print("Exception when calling ConversationApi->setDialogueSubject: %s\n" % e)

Parameters

Path parameters

Name	Description
dialogueId*	String specified dialogue id Required

Body parameters

Name	Description
body

Responses

Status: 201 - success

Status: 401 - permission denied

Status: 404 - dialogue not found

Status: 500 - internal server error

setInsightDialogue

Remove a specified insight. If the referenced dialogue is still active, the insight will get recreated with the next hook receiver update. Access granted to contact token of a connected card.

/conversation/insights/{dialogueId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
"//conversation/insights/{dialogueId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | insight id to update
        try {
            apiInstance.setInsightDialogue(dialogueId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#setInsightDialogue");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | insight id to update
        try {
            apiInstance.setInsightDialogue(dialogueId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#setInsightDialogue");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dialogueId = dialogueId_example; // insight id to update

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance setInsightDialogueWith:dialogueId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var dialogueId = dialogueId_example; // {{String}} insight id to update

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setInsightDialogue(dialogueId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dialogueId = dialogueId_example;  // String | insight id to update

            try
            {
                apiInstance.setInsightDialogue(dialogueId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.setInsightDialogue: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dialogueId = dialogueId_example; // String | insight id to update

try {
    $api_instance->setInsightDialogue($dialogueId);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->setInsightDialogue: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dialogueId = dialogueId_example; # String | insight id to update

eval { 
    $api_instance->setInsightDialogue(dialogueId => $dialogueId);
};
if ($@) {
    warn "Exception when calling ConversationApi->setInsightDialogue: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dialogueId = dialogueId_example # String | insight id to update

try: 
    api_instance.set_insight_dialogue(dialogueId)
except ApiException as e:
    print("Exception when calling ConversationApi->setInsightDialogue: %s\n" % e)

Parameters

Path parameters

Name	Description
dialogueId*	String insight id to update Required

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 404 - dialogue not found

Status: 500 - internal server error

setInsightStatus

Set the status of an insight. This will cause the hook receiver to return an inactive status. Access granted to app token of account holder.

/conversation/insights/{insightId}/status

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Content-Type: application/json"\
"//conversation/insights/{insightId}/status"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String insightId = insightId_example; // String | dialogue with insight id to update
        String body = ; // String | 
        try {
            apiInstance.setInsightStatus(insightId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#setInsightStatus");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String insightId = insightId_example; // String | dialogue with insight id to update
        String body = ; // String | 
        try {
            apiInstance.setInsightStatus(insightId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#setInsightStatus");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *insightId = insightId_example; // dialogue with insight id to update
String *body = ; //  (optional)

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance setInsightStatusWith:insightId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var insightId = insightId_example; // {{String}} dialogue with insight id to update
var opts = { 
  'body':  // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setInsightStatus(insightId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var insightId = insightId_example;  // String | dialogue with insight id to update
            var body = new String(); // String |  (optional) 

            try
            {
                apiInstance.setInsightStatus(insightId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.setInsightStatus: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$insightId = insightId_example; // String | dialogue with insight id to update
$body = ; // String | 

try {
    $api_instance->setInsightStatus($insightId, $body);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->setInsightStatus: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $insightId = insightId_example; # String | dialogue with insight id to update
my $body = WWW::SwaggerClient::Object::String->new(); # String | 

eval { 
    $api_instance->setInsightStatus(insightId => $insightId, body => $body);
};
if ($@) {
    warn "Exception when calling ConversationApi->setInsightStatus: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
insightId = insightId_example # String | dialogue with insight id to update
body =  # String |  (optional)

try: 
    api_instance.set_insight_status(insightId, body=body)
except ApiException as e:
    print("Exception when calling ConversationApi->setInsightStatus: %s\n" % e)

Parameters

Path parameters

Name	Description
insightId*	String dialogue with insight id to update Required

Body parameters

Name	Description
body

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 403 - invalid state

Status: 404 - insight not found

Status: 500 - internal server error

setTopicSubject

Set the subject for a topic. Authorization granted to account holder app token or dialogue member contact token who is also the creator of the topic.

/conversation/dialogues/{dialogueId}/topics/{topicId}/subject

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Content-Type: application/json"\
"//conversation/dialogues/{dialogueId}/topics/{topicId}/subject"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationApi;

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

public class ConversationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        TopicId_subject_body body = ; // TopicId_subject_body | 
        try {
            apiInstance.setTopicSubject(dialogueId, topicId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#setTopicSubject");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConversationApi;

public class ConversationApiExample {

    public static void main(String[] args) {
        ConversationApi apiInstance = new ConversationApi();
        String dialogueId = dialogueId_example; // String | specified dialogue id
        String topicId = topicId_example; // String | specified topic id
        TopicId_subject_body body = ; // TopicId_subject_body | 
        try {
            apiInstance.setTopicSubject(dialogueId, topicId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationApi#setTopicSubject");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *dialogueId = dialogueId_example; // specified dialogue id
String *topicId = topicId_example; // specified topic id
TopicId_subject_body *body = ; //  (optional)

ConversationApi *apiInstance = [[ConversationApi alloc] init];

[apiInstance setTopicSubjectWith:dialogueId
    topicId:topicId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ConversationApi()
var dialogueId = dialogueId_example; // {{String}} specified dialogue id
var topicId = topicId_example; // {{String}} specified topic id
var opts = { 
  'body':  // {{TopicId_subject_body}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setTopicSubject(dialogueIdtopicId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ConversationApi();
            var dialogueId = dialogueId_example;  // String | specified dialogue id
            var topicId = topicId_example;  // String | specified topic id
            var body = new TopicId_subject_body(); // TopicId_subject_body |  (optional) 

            try
            {
                apiInstance.setTopicSubject(dialogueId, topicId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationApi.setTopicSubject: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationApi();
$dialogueId = dialogueId_example; // String | specified dialogue id
$topicId = topicId_example; // String | specified topic id
$body = ; // TopicId_subject_body | 

try {
    $api_instance->setTopicSubject($dialogueId, $topicId, $body);
} catch (Exception $e) {
    echo 'Exception when calling ConversationApi->setTopicSubject: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationApi;


my $api_instance = WWW::SwaggerClient::ConversationApi->new();
my $dialogueId = dialogueId_example; # String | specified dialogue id
my $topicId = topicId_example; # String | specified topic id
my $body = WWW::SwaggerClient::Object::TopicId_subject_body->new(); # TopicId_subject_body | 

eval { 
    $api_instance->setTopicSubject(dialogueId => $dialogueId, topicId => $topicId, body => $body);
};
if ($@) {
    warn "Exception when calling ConversationApi->setTopicSubject: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationApi()
dialogueId = dialogueId_example # String | specified dialogue id
topicId = topicId_example # String | specified topic id
body =  # TopicId_subject_body |  (optional)

try: 
    api_instance.set_topic_subject(dialogueId, topicId, body=body)
except ApiException as e:
    print("Exception when calling ConversationApi->setTopicSubject: %s\n" % e)

Parameters

Path parameters

Name	Description
dialogueId*	String specified dialogue id Required
topicId*	String specified topic id Required

Body parameters

Name	Description
body

Responses

Status: 201 - entry created

Status: 401 - invalid token

Status: 403 - inactive dialogue

Status: 404 - topic or dialogue not found

Status: 500 - internal server error

Profile

getProfile

Get profile of accunt. Access granted to app token of account holder.

/profile

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//profile"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProfileApi;

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

public class ProfileApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ProfileApi apiInstance = new ProfileApi();
        try {
            Profile result = apiInstance.getProfile();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileApi#getProfile");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ProfileApi;

public class ProfileApiExample {

    public static void main(String[] args) {
        ProfileApi apiInstance = new ProfileApi();
        try {
            Profile result = apiInstance.getProfile();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileApi#getProfile");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

ProfileApi *apiInstance = [[ProfileApi alloc] init];

[apiInstance getProfileWithCompletionHandler: 
              ^(Profile output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ProfileApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProfile(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ProfileApi();

            try
            {
                Profile result = apiInstance.getProfile();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProfileApi.getProfile: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiProfileApi();

try {
    $result = $api_instance->getProfile();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProfileApi->getProfile: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProfileApi;


my $api_instance = WWW::SwaggerClient::ProfileApi->new();

eval { 
    my $result = $api_instance->getProfile();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProfileApi->getProfile: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ProfileApi()

try: 
    api_response = api_instance.get_profile()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfileApi->getProfile: %s\n" % e)

Parameters

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 500 - internal server error

getProfileImage

Download base64 decoded data of profile image. Access granted to app tokens of account holder.

/profile/image

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/octet-stream"\
"//profile/image"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProfileApi;

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

public class ProfileApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ProfileApi apiInstance = new ProfileApi();
        try {
            byte[] result = apiInstance.getProfileImage();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileApi#getProfileImage");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ProfileApi;

public class ProfileApiExample {

    public static void main(String[] args) {
        ProfileApi apiInstance = new ProfileApi();
        try {
            byte[] result = apiInstance.getProfileImage();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileApi#getProfileImage");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

ProfileApi *apiInstance = [[ProfileApi alloc] init];

[apiInstance getProfileImageWithCompletionHandler: 
              ^(byte[] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ProfileApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProfileImage(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ProfileApi();

            try
            {
                byte[] result = apiInstance.getProfileImage();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProfileApi.getProfileImage: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiProfileApi();

try {
    $result = $api_instance->getProfileImage();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProfileApi->getProfileImage: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProfileApi;


my $api_instance = WWW::SwaggerClient::ProfileApi->new();

eval { 
    my $result = $api_instance->getProfileImage();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProfileApi->getProfileImage: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ProfileApi()

try: 
    api_response = api_instance.get_profile_image()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfileApi->getProfileImage: %s\n" % e)

Parameters

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 405 - invalid image

Status: 500 - internal server error

getProfileMessage

Get a profile data message. Access granted to app token of account holder or contact token of connected contact.

/profile/message

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//profile/message"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProfileApi;

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

public class ProfileApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ProfileApi apiInstance = new ProfileApi();
        try {
            DataMessage result = apiInstance.getProfileMessage();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileApi#getProfileMessage");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ProfileApi;

public class ProfileApiExample {

    public static void main(String[] args) {
        ProfileApi apiInstance = new ProfileApi();
        try {
            DataMessage result = apiInstance.getProfileMessage();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileApi#getProfileMessage");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

ProfileApi *apiInstance = [[ProfileApi alloc] init];

[apiInstance getProfileMessageWithCompletionHandler: 
              ^(DataMessage output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ProfileApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProfileMessage(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ProfileApi();

            try
            {
                DataMessage result = apiInstance.getProfileMessage();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProfileApi.getProfileMessage: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiProfileApi();

try {
    $result = $api_instance->getProfileMessage();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProfileApi->getProfileMessage: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProfileApi;


my $api_instance = WWW::SwaggerClient::ProfileApi->new();

eval { 
    my $result = $api_instance->getProfileMessage();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProfileApi->getProfileMessage: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ProfileApi()

try: 
    api_response = api_instance.get_profile_message()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfileApi->getProfileMessage: %s\n" % e)

Parameters

Responses

Status: 200 - success

Schema

Status: 401 - permission denied

Status: 500 - internal server error

setProfile

Set profile data. Access granted to app tokens of account holder.

/profile

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Content-Type: application/json"\
"//profile"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProfileApi;

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

public class ProfileApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ProfileApi apiInstance = new ProfileApi();
        ProfileData body = ; // ProfileData | 
        try {
            apiInstance.setProfile(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileApi#setProfile");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ProfileApi;

public class ProfileApiExample {

    public static void main(String[] args) {
        ProfileApi apiInstance = new ProfileApi();
        ProfileData body = ; // ProfileData | 
        try {
            apiInstance.setProfile(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileApi#setProfile");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
ProfileData *body = ; //  (optional)

ProfileApi *apiInstance = [[ProfileApi alloc] init];

[apiInstance setProfileWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ProfileApi()
var opts = { 
  'body':  // {{ProfileData}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setProfile(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ProfileApi();
            var body = new ProfileData(); // ProfileData |  (optional) 

            try
            {
                apiInstance.setProfile(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProfileApi.setProfile: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiProfileApi();
$body = ; // ProfileData | 

try {
    $api_instance->setProfile($body);
} catch (Exception $e) {
    echo 'Exception when calling ProfileApi->setProfile: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProfileApi;


my $api_instance = WWW::SwaggerClient::ProfileApi->new();
my $body = WWW::SwaggerClient::Object::ProfileData->new(); # ProfileData | 

eval { 
    $api_instance->setProfile(body => $body);
};
if ($@) {
    warn "Exception when calling ProfileApi->setProfile: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ProfileApi()
body =  # ProfileData |  (optional)

try: 
    api_instance.set_profile(body=body)
except ApiException as e:
    print("Exception when calling ProfileApi->setProfile: %s\n" % e)

Parameters

Body parameters

Name	Description
body

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 500 - internal server error

addGroup

Add a group for sharing. Access granted to app tokens of account holder.

/share/groups

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Content-Type: application/json"\
"//share/groups"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShareApi;

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

public class ShareApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ShareApi apiInstance = new ShareApi();
        Share_groups_body body = ; // Share_groups_body | 
        try {
            apiInstance.addGroup(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShareApi#addGroup");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ShareApi;

public class ShareApiExample {

    public static void main(String[] args) {
        ShareApi apiInstance = new ShareApi();
        Share_groups_body body = ; // Share_groups_body | 
        try {
            apiInstance.addGroup(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShareApi#addGroup");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
Share_groups_body *body = ; //  (optional)

ShareApi *apiInstance = [[ShareApi alloc] init];

[apiInstance addGroupWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ShareApi()
var opts = { 
  'body':  // {{Share_groups_body}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addGroup(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ShareApi();
            var body = new Share_groups_body(); // Share_groups_body |  (optional) 

            try
            {
                apiInstance.addGroup(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShareApi.addGroup: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiShareApi();
$body = ; // Share_groups_body | 

try {
    $api_instance->addGroup($body);
} catch (Exception $e) {
    echo 'Exception when calling ShareApi->addGroup: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShareApi;


my $api_instance = WWW::SwaggerClient::ShareApi->new();
my $body = WWW::SwaggerClient::Object::Share_groups_body->new(); # Share_groups_body | 

eval { 
    $api_instance->addGroup(body => $body);
};
if ($@) {
    warn "Exception when calling ShareApi->addGroup: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ShareApi()
body =  # Share_groups_body |  (optional)

try: 
    api_instance.add_group(body=body)
except ApiException as e:
    print("Exception when calling ShareApi->addGroup: %s\n" % e)

Parameters

Body parameters

Name	Description
body

Responses

Status: 200 - entry created

Status: 401 - permission denied

Status: 500 - internal server error

getGroups

Get groups for sharing. Access granted to app tokens of the account holder.

/share/groups

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//share/groups"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShareApi;

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

public class ShareApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ShareApi apiInstance = new ShareApi();
        try {
            array[Group] result = apiInstance.getGroups();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShareApi#getGroups");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ShareApi;

public class ShareApiExample {

    public static void main(String[] args) {
        ShareApi apiInstance = new ShareApi();
        try {
            array[Group] result = apiInstance.getGroups();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShareApi#getGroups");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

ShareApi *apiInstance = [[ShareApi alloc] init];

[apiInstance getGroupsWithCompletionHandler: 
              ^(array[Group] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ShareApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGroups(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ShareApi();

            try
            {
                array[Group] result = apiInstance.getGroups();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShareApi.getGroups: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiShareApi();

try {
    $result = $api_instance->getGroups();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShareApi->getGroups: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShareApi;


my $api_instance = WWW::SwaggerClient::ShareApi->new();

eval { 
    my $result = $api_instance->getGroups();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShareApi->getGroups: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ShareApi()

try: 
    api_response = api_instance.get_groups()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShareApi->getGroups: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation

Schema

Status: 401 - invalid token

Status: 500 - internal server error

removeGroup

Remove sharing group

/share/groups/{groupId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
"//share/groups/{groupId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShareApi;

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

public class ShareApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ShareApi apiInstance = new ShareApi();
        String groupId = groupId_example; // String | specified group id
        try {
            apiInstance.removeGroup(groupId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShareApi#removeGroup");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ShareApi;

public class ShareApiExample {

    public static void main(String[] args) {
        ShareApi apiInstance = new ShareApi();
        String groupId = groupId_example; // String | specified group id
        try {
            apiInstance.removeGroup(groupId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShareApi#removeGroup");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *groupId = groupId_example; // specified group id

ShareApi *apiInstance = [[ShareApi alloc] init];

[apiInstance removeGroupWith:groupId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ShareApi()
var groupId = groupId_example; // {{String}} specified group id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeGroup(groupId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ShareApi();
            var groupId = groupId_example;  // String | specified group id

            try
            {
                apiInstance.removeGroup(groupId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShareApi.removeGroup: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiShareApi();
$groupId = groupId_example; // String | specified group id

try {
    $api_instance->removeGroup($groupId);
} catch (Exception $e) {
    echo 'Exception when calling ShareApi->removeGroup: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShareApi;


my $api_instance = WWW::SwaggerClient::ShareApi->new();
my $groupId = groupId_example; # String | specified group id

eval { 
    $api_instance->removeGroup(groupId => $groupId);
};
if ($@) {
    warn "Exception when calling ShareApi->removeGroup: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ShareApi()
groupId = groupId_example # String | specified group id

try: 
    api_instance.remove_group(groupId)
except ApiException as e:
    print("Exception when calling ShareApi->removeGroup: %s\n" % e)

Parameters

Path parameters

Name	Description
groupId*	String specified group id Required

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 404 - group not found

Status: 500 - internal server error

updateGroup

Update group description for sharing. Access granted to app tokens of account holder.

/share/groups/{groupId}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Content-Type: application/json"\
"//share/groups/{groupId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShareApi;

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

public class ShareApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ShareApi apiInstance = new ShareApi();
        String groupId = groupId_example; // String | specified group id
        Groups_groupId_body body = ; // Groups_groupId_body | 
        try {
            apiInstance.updateGroup(groupId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShareApi#updateGroup");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ShareApi;

public class ShareApiExample {

    public static void main(String[] args) {
        ShareApi apiInstance = new ShareApi();
        String groupId = groupId_example; // String | specified group id
        Groups_groupId_body body = ; // Groups_groupId_body | 
        try {
            apiInstance.updateGroup(groupId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShareApi#updateGroup");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *groupId = groupId_example; // specified group id
Groups_groupId_body *body = ; //  (optional)

ShareApi *apiInstance = [[ShareApi alloc] init];

[apiInstance updateGroupWith:groupId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');
var defaultClient = DataBag.ApiClient.instance;


var api = new DataBag.ShareApi()
var groupId = groupId_example; // {{String}} specified group id
var opts = { 
  'body':  // {{Groups_groupId_body}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateGroup(groupId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ShareApi();
            var groupId = groupId_example;  // String | specified group id
            var body = new Groups_groupId_body(); // Groups_groupId_body |  (optional) 

            try
            {
                apiInstance.updateGroup(groupId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShareApi.updateGroup: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiShareApi();
$groupId = groupId_example; // String | specified group id
$body = ; // Groups_groupId_body | 

try {
    $api_instance->updateGroup($groupId, $body);
} catch (Exception $e) {
    echo 'Exception when calling ShareApi->updateGroup: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShareApi;


my $api_instance = WWW::SwaggerClient::ShareApi->new();
my $groupId = groupId_example; # String | specified group id
my $body = WWW::SwaggerClient::Object::Groups_groupId_body->new(); # Groups_groupId_body | 

eval { 
    $api_instance->updateGroup(groupId => $groupId, body => $body);
};
if ($@) {
    warn "Exception when calling ShareApi->updateGroup: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ShareApi()
groupId = groupId_example # String | specified group id
body =  # Groups_groupId_body |  (optional)

try: 
    api_instance.update_group(groupId, body=body)
except ApiException as e:
    print("Exception when calling ShareApi->updateGroup: %s\n" % e)

Parameters

Path parameters

Name	Description
groupId*	String specified group id Required

Body parameters

Name	Description
body

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 404 - group not found

Status: 500 - internal server error

Status

status

Websocket placeholder endpoint for receiving account status updates

/status

Usage and SDK Samples

curl -X GET\
"//status"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StatusApi;

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

public class StatusApiExample {

    public static void main(String[] args) {
        
        StatusApi apiInstance = new StatusApi();
        try {
            apiInstance.status();
        } catch (ApiException e) {
            System.err.println("Exception when calling StatusApi#status");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.StatusApi;

public class StatusApiExample {

    public static void main(String[] args) {
        StatusApi apiInstance = new StatusApi();
        try {
            apiInstance.status();
        } catch (ApiException e) {
            System.err.println("Exception when calling StatusApi#status");
            e.printStackTrace();
        }
    }
}


StatusApi *apiInstance = [[StatusApi alloc] init];

[apiInstance statusWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var DataBag = require('data_bag');

var api = new DataBag.StatusApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.status(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new StatusApi();

            try
            {
                apiInstance.status();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StatusApi.status: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStatusApi();

try {
    $api_instance->status();
} catch (Exception $e) {
    echo 'Exception when calling StatusApi->status: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StatusApi;

my $api_instance = WWW::SwaggerClient::StatusApi->new();

eval { 
    $api_instance->status();
};
if ($@) {
    warn "Exception when calling StatusApi->status: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StatusApi()

try: 
    api_instance.status()
except ApiException as e:
    print("Exception when calling StatusApi->status: %s\n" % e)

DataBag

API and SDK Documentation

Account

addAccount

Usage and SDK Samples

Parameters

Responses

Status: 201 - successful operation

Status: 400 - invalid handle or password

Status: 401 - invalid bearer token

Status: 500 - internal server error

addAccountApp

Usage and SDK Samples

Parameters

Responses

Status: 201 - generated

Status: 401 - invalid password

Status: 500 - internal server error

addAccountAuthentication

Usage and SDK Samples

Parameters

Responses

Status: 201 - generated

Status: 401 - invalid password

Status: 500 - internal server error

getAccountApps

Usage and SDK Samples

Parameters

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 500 - internal server error

getAccountImage

Usage and SDK Samples

Parameters

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 405 - invalid image

Status: 500 - internal server error

getAccountProfile

Usage and SDK Samples

Parameters

Responses

Status: 200 - successful operation

Status: 401 - authentication error

Status: 500 - internal server error

getAccountToken

Usage and SDK Samples

Parameters

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 500 - internal server error

getAccountUsername

Usage and SDK Samples

Parameters

Responses

Status: 200 - success

Status: 401 - permission denied

Status: 406 - username already claimed

Status: 500 - internal server error

removeAccountApp

Usage and SDK Samples

Parameters

Responses

Status: 200 - successful operation

Status: 401 - invalid password

Status: 404 - app not found

Status: 500 - internal server error

setAccountApp

Usage and SDK Samples

Parameters

Responses

Status: 201 - generated

Status: 401 - invalid token

Status: 406 - app limit reached

Status: 500 - internal server error

setAccountAuthentication

Usage and SDK Samples