Quriobot API

BackofficeAgent

backofficeAgentCreate

create backoffice_agent

Create agent


/0.0.1/backoffice/agents

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/agents"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeAgentApi;

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

public class BackofficeAgentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeAgentApi apiInstance = new BackofficeAgentApi();
        String organisation = organisation_example; // String | 
        AgentPayload payload = ; // AgentPayload | Agent payload
        try {
            Agent result = apiInstance.backofficeAgentCreate(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAgentApi#backofficeAgentCreate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeAgentApi;

public class BackofficeAgentApiExample {

    public static void main(String[] args) {
        BackofficeAgentApi apiInstance = new BackofficeAgentApi();
        String organisation = organisation_example; // String | 
        AgentPayload payload = ; // AgentPayload | Agent payload
        try {
            Agent result = apiInstance.backofficeAgentCreate(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAgentApi#backofficeAgentCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
AgentPayload *payload = ; // Agent payload

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

// create backoffice_agent
[apiInstance backofficeAgentCreateWith:organisation
    payload:payload
              completionHandler: ^(Agent output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeAgentApi()

var organisation = organisation_example; // {String} 

var payload = ; // {AgentPayload} Agent payload

api.backofficeAgentCreate(organisation, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeAgentCreateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeAgentApi();
            var organisation = organisation_example;  // String | 
            var payload = new AgentPayload(); // AgentPayload | Agent payload

            try
            {
                // create backoffice_agent
                Agent result = apiInstance.backofficeAgentCreate(organisation, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeAgentApi.backofficeAgentCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeAgentApi();
$organisation = organisation_example; // String | 
$payload = ; // AgentPayload | Agent payload

try {
    $result = $api_instance->backofficeAgentCreate($organisation, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeAgentApi->backofficeAgentCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeAgentApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeAgentApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::AgentPayload->new(); # AgentPayload | Agent payload

eval { 
    my $result = $api_instance->backofficeAgentCreate(organisation => $organisation, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeAgentApi->backofficeAgentCreate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeAgentApi()
organisation = organisation_example # String | 
payload =  # AgentPayload | Agent payload

try: 
    # create backoffice_agent
    api_response = api_instance.backoffice_agent_create(organisation, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeAgentApi->backofficeAgentCreate: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeAgentDelete

delete backoffice_agent


/0.0.1/backoffice/agents/{id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/agents/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeAgentApi;

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

public class BackofficeAgentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeAgentApi apiInstance = new BackofficeAgentApi();
        String id = id_example; // String | Agent ID
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeAgentDelete(id, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAgentApi#backofficeAgentDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeAgentApi;

public class BackofficeAgentApiExample {

    public static void main(String[] args) {
        BackofficeAgentApi apiInstance = new BackofficeAgentApi();
        String id = id_example; // String | Agent ID
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeAgentDelete(id, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAgentApi#backofficeAgentDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Agent ID
String *organisation = organisation_example; // 

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

// delete backoffice_agent
[apiInstance backofficeAgentDeleteWith:id
    organisation:organisation
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeAgentApi()

var id = id_example; // {String} Agent ID

var organisation = organisation_example; // {String} 

api.backofficeAgentDelete(id, organisation).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeAgentDeleteExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeAgentApi();
            var id = id_example;  // String | Agent ID
            var organisation = organisation_example;  // String | 

            try
            {
                // delete backoffice_agent
                apiInstance.backofficeAgentDelete(id, organisation);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeAgentApi.backofficeAgentDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeAgentApi();
$id = id_example; // String | Agent ID
$organisation = organisation_example; // String | 

try {
    $api_instance->backofficeAgentDelete($id, $organisation);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeAgentApi->backofficeAgentDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeAgentApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeAgentApi->new();
my $id = id_example; # String | Agent ID
my $organisation = organisation_example; # String | 

eval { 
    $api_instance->backofficeAgentDelete(id => $id, organisation => $organisation);
};
if ($@) {
    warn "Exception when calling BackofficeAgentApi->backofficeAgentDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeAgentApi()
id = id_example # String | Agent ID
organisation = organisation_example # String | 

try: 
    # delete backoffice_agent
    api_instance.backoffice_agent_delete(id, organisation)
except ApiException as e:
    print("Exception when calling BackofficeAgentApi->backofficeAgentDelete: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Agent ID
Required
Header parameters
Name Description
Organisation*
String
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeAgentList

list backoffice_agent

Retrieve all agents.


/0.0.1/backoffice/agents/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/agents/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeAgentApi;

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

public class BackofficeAgentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeAgentApi apiInstance = new BackofficeAgentApi();
        String organisation = organisation_example; // String | 
        AgentCollectionPayload payload = ; // AgentCollectionPayload | Agent collection payload
        try {
            Agent_collection result = apiInstance.backofficeAgentList(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAgentApi#backofficeAgentList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeAgentApi;

public class BackofficeAgentApiExample {

    public static void main(String[] args) {
        BackofficeAgentApi apiInstance = new BackofficeAgentApi();
        String organisation = organisation_example; // String | 
        AgentCollectionPayload payload = ; // AgentCollectionPayload | Agent collection payload
        try {
            Agent_collection result = apiInstance.backofficeAgentList(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAgentApi#backofficeAgentList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
AgentCollectionPayload *payload = ; // Agent collection payload

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

// list backoffice_agent
[apiInstance backofficeAgentListWith:organisation
    payload:payload
              completionHandler: ^(Agent_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeAgentApi()

var organisation = organisation_example; // {String} 

var payload = ; // {AgentCollectionPayload} Agent collection payload

api.backofficeAgentList(organisation, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeAgentListExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeAgentApi();
            var organisation = organisation_example;  // String | 
            var payload = new AgentCollectionPayload(); // AgentCollectionPayload | Agent collection payload

            try
            {
                // list backoffice_agent
                Agent_collection result = apiInstance.backofficeAgentList(organisation, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeAgentApi.backofficeAgentList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeAgentApi();
$organisation = organisation_example; // String | 
$payload = ; // AgentCollectionPayload | Agent collection payload

try {
    $result = $api_instance->backofficeAgentList($organisation, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeAgentApi->backofficeAgentList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeAgentApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeAgentApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::AgentCollectionPayload->new(); # AgentCollectionPayload | Agent collection payload

eval { 
    my $result = $api_instance->backofficeAgentList(organisation => $organisation, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeAgentApi->backofficeAgentList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeAgentApi()
organisation = organisation_example # String | 
payload =  # AgentCollectionPayload | Agent collection payload

try: 
    # list backoffice_agent
    api_response = api_instance.backoffice_agent_list(organisation, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeAgentApi->backofficeAgentList: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeAgentShow

show backoffice_agent

Get agent


/0.0.1/backoffice/agents/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/agents/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeAgentApi;

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

public class BackofficeAgentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeAgentApi apiInstance = new BackofficeAgentApi();
        String id = id_example; // String | Agent ID
        String organisation = organisation_example; // String | 
        try {
            Agent result = apiInstance.backofficeAgentShow(id, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAgentApi#backofficeAgentShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeAgentApi;

public class BackofficeAgentApiExample {

    public static void main(String[] args) {
        BackofficeAgentApi apiInstance = new BackofficeAgentApi();
        String id = id_example; // String | Agent ID
        String organisation = organisation_example; // String | 
        try {
            Agent result = apiInstance.backofficeAgentShow(id, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAgentApi#backofficeAgentShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Agent ID
String *organisation = organisation_example; // 

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

// show backoffice_agent
[apiInstance backofficeAgentShowWith:id
    organisation:organisation
              completionHandler: ^(Agent output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeAgentApi()

var id = id_example; // {String} Agent ID

var organisation = organisation_example; // {String} 

api.backofficeAgentShow(id, organisation).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeAgentShowExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeAgentApi();
            var id = id_example;  // String | Agent ID
            var organisation = organisation_example;  // String | 

            try
            {
                // show backoffice_agent
                Agent result = apiInstance.backofficeAgentShow(id, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeAgentApi.backofficeAgentShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeAgentApi();
$id = id_example; // String | Agent ID
$organisation = organisation_example; // String | 

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

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeAgentApi->new();
my $id = id_example; # String | Agent ID
my $organisation = organisation_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeAgentApi()
id = id_example # String | Agent ID
organisation = organisation_example # String | 

try: 
    # show backoffice_agent
    api_response = api_instance.backoffice_agent_show(id, organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeAgentApi->backofficeAgentShow: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Agent ID
Required
Header parameters
Name Description
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeAgentUpdate

update backoffice_agent

Change agent


/0.0.1/backoffice/agents/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/agents/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeAgentApi;

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

public class BackofficeAgentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeAgentApi apiInstance = new BackofficeAgentApi();
        String id = id_example; // String | Agent ID
        String organisation = organisation_example; // String | 
        AgentPayload payload = ; // AgentPayload | Agent payload
        try {
            Agent result = apiInstance.backofficeAgentUpdate(id, organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAgentApi#backofficeAgentUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeAgentApi;

public class BackofficeAgentApiExample {

    public static void main(String[] args) {
        BackofficeAgentApi apiInstance = new BackofficeAgentApi();
        String id = id_example; // String | Agent ID
        String organisation = organisation_example; // String | 
        AgentPayload payload = ; // AgentPayload | Agent payload
        try {
            Agent result = apiInstance.backofficeAgentUpdate(id, organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAgentApi#backofficeAgentUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Agent ID
String *organisation = organisation_example; // 
AgentPayload *payload = ; // Agent payload

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

// update backoffice_agent
[apiInstance backofficeAgentUpdateWith:id
    organisation:organisation
    payload:payload
              completionHandler: ^(Agent output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeAgentApi()

var id = id_example; // {String} Agent ID

var organisation = organisation_example; // {String} 

var payload = ; // {AgentPayload} Agent payload

api.backofficeAgentUpdate(id, organisation, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeAgentUpdateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeAgentApi();
            var id = id_example;  // String | Agent ID
            var organisation = organisation_example;  // String | 
            var payload = new AgentPayload(); // AgentPayload | Agent payload

            try
            {
                // update backoffice_agent
                Agent result = apiInstance.backofficeAgentUpdate(id, organisation, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeAgentApi.backofficeAgentUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeAgentApi();
$id = id_example; // String | Agent ID
$organisation = organisation_example; // String | 
$payload = ; // AgentPayload | Agent payload

try {
    $result = $api_instance->backofficeAgentUpdate($id, $organisation, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeAgentApi->backofficeAgentUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeAgentApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeAgentApi->new();
my $id = id_example; # String | Agent ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::AgentPayload->new(); # AgentPayload | Agent payload

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeAgentApi()
id = id_example # String | Agent ID
organisation = organisation_example # String | 
payload =  # AgentPayload | Agent payload

try: 
    # update backoffice_agent
    api_response = api_instance.backoffice_agent_update(id, organisation, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeAgentApi->backofficeAgentUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Agent ID
Required
Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


BackofficeAgentGroup

backofficeAgentGroupCreate

create backoffice_agent_group

Create agent group


/0.0.1/backoffice/agent_groups

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/agent_groups"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeAgentGroupApi;

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

public class BackofficeAgentGroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeAgentGroupApi apiInstance = new BackofficeAgentGroupApi();
        String organisation = organisation_example; // String | 
        AgentGroupPayload payload = ; // AgentGroupPayload | Agent group payload
        try {
            Agent_group result = apiInstance.backofficeAgentGroupCreate(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAgentGroupApi#backofficeAgentGroupCreate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeAgentGroupApi;

public class BackofficeAgentGroupApiExample {

    public static void main(String[] args) {
        BackofficeAgentGroupApi apiInstance = new BackofficeAgentGroupApi();
        String organisation = organisation_example; // String | 
        AgentGroupPayload payload = ; // AgentGroupPayload | Agent group payload
        try {
            Agent_group result = apiInstance.backofficeAgentGroupCreate(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAgentGroupApi#backofficeAgentGroupCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
AgentGroupPayload *payload = ; // Agent group payload

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

// create backoffice_agent_group
[apiInstance backofficeAgentGroupCreateWith:organisation
    payload:payload
              completionHandler: ^(Agent_group output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeAgentGroupApi()

var organisation = organisation_example; // {String} 

var payload = ; // {AgentGroupPayload} Agent group payload

api.backofficeAgentGroupCreate(organisation, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeAgentGroupCreateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeAgentGroupApi();
            var organisation = organisation_example;  // String | 
            var payload = new AgentGroupPayload(); // AgentGroupPayload | Agent group payload

            try
            {
                // create backoffice_agent_group
                Agent_group result = apiInstance.backofficeAgentGroupCreate(organisation, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeAgentGroupApi.backofficeAgentGroupCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeAgentGroupApi();
$organisation = organisation_example; // String | 
$payload = ; // AgentGroupPayload | Agent group payload

try {
    $result = $api_instance->backofficeAgentGroupCreate($organisation, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeAgentGroupApi->backofficeAgentGroupCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeAgentGroupApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeAgentGroupApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::AgentGroupPayload->new(); # AgentGroupPayload | Agent group payload

eval { 
    my $result = $api_instance->backofficeAgentGroupCreate(organisation => $organisation, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeAgentGroupApi->backofficeAgentGroupCreate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeAgentGroupApi()
organisation = organisation_example # String | 
payload =  # AgentGroupPayload | Agent group payload

try: 
    # create backoffice_agent_group
    api_response = api_instance.backoffice_agent_group_create(organisation, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeAgentGroupApi->backofficeAgentGroupCreate: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeAgentGroupCreateMember

create_member backoffice_agent_group

Create agent group member


/0.0.1/backoffice/agent_groups/{id}/members

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/agent_groups/{id}/members"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeAgentGroupApi;

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

public class BackofficeAgentGroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeAgentGroupApi apiInstance = new BackofficeAgentGroupApi();
        String id = id_example; // String | 
        String organisation = organisation_example; // String | 
        AgentGroupMemberPayload payload = ; // AgentGroupMemberPayload | Agent group member payload
        try {
            apiInstance.backofficeAgentGroupCreateMember(id, organisation, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAgentGroupApi#backofficeAgentGroupCreateMember");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeAgentGroupApi;

public class BackofficeAgentGroupApiExample {

    public static void main(String[] args) {
        BackofficeAgentGroupApi apiInstance = new BackofficeAgentGroupApi();
        String id = id_example; // String | 
        String organisation = organisation_example; // String | 
        AgentGroupMemberPayload payload = ; // AgentGroupMemberPayload | Agent group member payload
        try {
            apiInstance.backofficeAgentGroupCreateMember(id, organisation, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAgentGroupApi#backofficeAgentGroupCreateMember");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // 
String *organisation = organisation_example; // 
AgentGroupMemberPayload *payload = ; // Agent group member payload

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

// create_member backoffice_agent_group
[apiInstance backofficeAgentGroupCreateMemberWith:id
    organisation:organisation
    payload:payload
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeAgentGroupApi()

var id = id_example; // {String} 

var organisation = organisation_example; // {String} 

var payload = ; // {AgentGroupMemberPayload} Agent group member payload

api.backofficeAgentGroupCreateMember(id, organisation, payload).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeAgentGroupCreateMemberExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeAgentGroupApi();
            var id = id_example;  // String | 
            var organisation = organisation_example;  // String | 
            var payload = new AgentGroupMemberPayload(); // AgentGroupMemberPayload | Agent group member payload

            try
            {
                // create_member backoffice_agent_group
                apiInstance.backofficeAgentGroupCreateMember(id, organisation, payload);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeAgentGroupApi.backofficeAgentGroupCreateMember: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeAgentGroupApi();
$id = id_example; // String | 
$organisation = organisation_example; // String | 
$payload = ; // AgentGroupMemberPayload | Agent group member payload

try {
    $api_instance->backofficeAgentGroupCreateMember($id, $organisation, $payload);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeAgentGroupApi->backofficeAgentGroupCreateMember: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeAgentGroupApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeAgentGroupApi->new();
my $id = id_example; # String | 
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::AgentGroupMemberPayload->new(); # AgentGroupMemberPayload | Agent group member payload

eval { 
    $api_instance->backofficeAgentGroupCreateMember(id => $id, organisation => $organisation, payload => $payload);
};
if ($@) {
    warn "Exception when calling BackofficeAgentGroupApi->backofficeAgentGroupCreateMember: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeAgentGroupApi()
id = id_example # String | 
organisation = organisation_example # String | 
payload =  # AgentGroupMemberPayload | Agent group member payload

try: 
    # create_member backoffice_agent_group
    api_instance.backoffice_agent_group_create_member(id, organisation, payload)
except ApiException as e:
    print("Exception when calling BackofficeAgentGroupApi->backofficeAgentGroupCreateMember: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required
Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeAgentGroupDelete

delete backoffice_agent_group


/0.0.1/backoffice/agent_groups/{id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/agent_groups/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeAgentGroupApi;

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

public class BackofficeAgentGroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeAgentGroupApi apiInstance = new BackofficeAgentGroupApi();
        String id = id_example; // String | Agent group ID
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeAgentGroupDelete(id, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAgentGroupApi#backofficeAgentGroupDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeAgentGroupApi;

public class BackofficeAgentGroupApiExample {

    public static void main(String[] args) {
        BackofficeAgentGroupApi apiInstance = new BackofficeAgentGroupApi();
        String id = id_example; // String | Agent group ID
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeAgentGroupDelete(id, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAgentGroupApi#backofficeAgentGroupDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Agent group ID
String *organisation = organisation_example; // 

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

// delete backoffice_agent_group
[apiInstance backofficeAgentGroupDeleteWith:id
    organisation:organisation
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeAgentGroupApi()

var id = id_example; // {String} Agent group ID

var organisation = organisation_example; // {String} 

api.backofficeAgentGroupDelete(id, organisation).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeAgentGroupDeleteExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeAgentGroupApi();
            var id = id_example;  // String | Agent group ID
            var organisation = organisation_example;  // String | 

            try
            {
                // delete backoffice_agent_group
                apiInstance.backofficeAgentGroupDelete(id, organisation);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeAgentGroupApi.backofficeAgentGroupDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeAgentGroupApi();
$id = id_example; // String | Agent group ID
$organisation = organisation_example; // String | 

try {
    $api_instance->backofficeAgentGroupDelete($id, $organisation);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeAgentGroupApi->backofficeAgentGroupDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeAgentGroupApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeAgentGroupApi->new();
my $id = id_example; # String | Agent group ID
my $organisation = organisation_example; # String | 

eval { 
    $api_instance->backofficeAgentGroupDelete(id => $id, organisation => $organisation);
};
if ($@) {
    warn "Exception when calling BackofficeAgentGroupApi->backofficeAgentGroupDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeAgentGroupApi()
id = id_example # String | Agent group ID
organisation = organisation_example # String | 

try: 
    # delete backoffice_agent_group
    api_instance.backoffice_agent_group_delete(id, organisation)
except ApiException as e:
    print("Exception when calling BackofficeAgentGroupApi->backofficeAgentGroupDelete: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Agent group ID
Required
Header parameters
Name Description
Organisation*
String
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeAgentGroupDeleteMember

delete_member backoffice_agent_group

Delete agent group members


/0.0.1/backoffice/agent_groups/{id}/members

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/agent_groups/{id}/members"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeAgentGroupApi;

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

public class BackofficeAgentGroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeAgentGroupApi apiInstance = new BackofficeAgentGroupApi();
        String id = id_example; // String | 
        String organisation = organisation_example; // String | 
        AgentGroupMemberPayload payload = ; // AgentGroupMemberPayload | Agent group member payload
        try {
            apiInstance.backofficeAgentGroupDeleteMember(id, organisation, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAgentGroupApi#backofficeAgentGroupDeleteMember");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeAgentGroupApi;

public class BackofficeAgentGroupApiExample {

    public static void main(String[] args) {
        BackofficeAgentGroupApi apiInstance = new BackofficeAgentGroupApi();
        String id = id_example; // String | 
        String organisation = organisation_example; // String | 
        AgentGroupMemberPayload payload = ; // AgentGroupMemberPayload | Agent group member payload
        try {
            apiInstance.backofficeAgentGroupDeleteMember(id, organisation, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAgentGroupApi#backofficeAgentGroupDeleteMember");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // 
String *organisation = organisation_example; // 
AgentGroupMemberPayload *payload = ; // Agent group member payload

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

// delete_member backoffice_agent_group
[apiInstance backofficeAgentGroupDeleteMemberWith:id
    organisation:organisation
    payload:payload
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeAgentGroupApi()

var id = id_example; // {String} 

var organisation = organisation_example; // {String} 

var payload = ; // {AgentGroupMemberPayload} Agent group member payload

api.backofficeAgentGroupDeleteMember(id, organisation, payload).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeAgentGroupDeleteMemberExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeAgentGroupApi();
            var id = id_example;  // String | 
            var organisation = organisation_example;  // String | 
            var payload = new AgentGroupMemberPayload(); // AgentGroupMemberPayload | Agent group member payload

            try
            {
                // delete_member backoffice_agent_group
                apiInstance.backofficeAgentGroupDeleteMember(id, organisation, payload);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeAgentGroupApi.backofficeAgentGroupDeleteMember: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeAgentGroupApi();
$id = id_example; // String | 
$organisation = organisation_example; // String | 
$payload = ; // AgentGroupMemberPayload | Agent group member payload

try {
    $api_instance->backofficeAgentGroupDeleteMember($id, $organisation, $payload);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeAgentGroupApi->backofficeAgentGroupDeleteMember: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeAgentGroupApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeAgentGroupApi->new();
my $id = id_example; # String | 
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::AgentGroupMemberPayload->new(); # AgentGroupMemberPayload | Agent group member payload

eval { 
    $api_instance->backofficeAgentGroupDeleteMember(id => $id, organisation => $organisation, payload => $payload);
};
if ($@) {
    warn "Exception when calling BackofficeAgentGroupApi->backofficeAgentGroupDeleteMember: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeAgentGroupApi()
id = id_example # String | 
organisation = organisation_example # String | 
payload =  # AgentGroupMemberPayload | Agent group member payload

try: 
    # delete_member backoffice_agent_group
    api_instance.backoffice_agent_group_delete_member(id, organisation, payload)
except ApiException as e:
    print("Exception when calling BackofficeAgentGroupApi->backofficeAgentGroupDeleteMember: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required
Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeAgentGroupList

list backoffice_agent_group

Retrieve all agents.


/0.0.1/backoffice/agent_groups/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/agent_groups/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeAgentGroupApi;

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

public class BackofficeAgentGroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeAgentGroupApi apiInstance = new BackofficeAgentGroupApi();
        String organisation = organisation_example; // String | 
        AgentGroupCollectionPayload payload = ; // AgentGroupCollectionPayload | Agent group collection payload
        try {
            Agent_group_collection result = apiInstance.backofficeAgentGroupList(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAgentGroupApi#backofficeAgentGroupList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeAgentGroupApi;

public class BackofficeAgentGroupApiExample {

    public static void main(String[] args) {
        BackofficeAgentGroupApi apiInstance = new BackofficeAgentGroupApi();
        String organisation = organisation_example; // String | 
        AgentGroupCollectionPayload payload = ; // AgentGroupCollectionPayload | Agent group collection payload
        try {
            Agent_group_collection result = apiInstance.backofficeAgentGroupList(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAgentGroupApi#backofficeAgentGroupList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
AgentGroupCollectionPayload *payload = ; // Agent group collection payload

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

// list backoffice_agent_group
[apiInstance backofficeAgentGroupListWith:organisation
    payload:payload
              completionHandler: ^(Agent_group_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeAgentGroupApi()

var organisation = organisation_example; // {String} 

var payload = ; // {AgentGroupCollectionPayload} Agent group collection payload

api.backofficeAgentGroupList(organisation, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeAgentGroupListExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeAgentGroupApi();
            var organisation = organisation_example;  // String | 
            var payload = new AgentGroupCollectionPayload(); // AgentGroupCollectionPayload | Agent group collection payload

            try
            {
                // list backoffice_agent_group
                Agent_group_collection result = apiInstance.backofficeAgentGroupList(organisation, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeAgentGroupApi.backofficeAgentGroupList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeAgentGroupApi();
$organisation = organisation_example; // String | 
$payload = ; // AgentGroupCollectionPayload | Agent group collection payload

try {
    $result = $api_instance->backofficeAgentGroupList($organisation, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeAgentGroupApi->backofficeAgentGroupList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeAgentGroupApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeAgentGroupApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::AgentGroupCollectionPayload->new(); # AgentGroupCollectionPayload | Agent group collection payload

eval { 
    my $result = $api_instance->backofficeAgentGroupList(organisation => $organisation, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeAgentGroupApi->backofficeAgentGroupList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeAgentGroupApi()
organisation = organisation_example # String | 
payload =  # AgentGroupCollectionPayload | Agent group collection payload

try: 
    # list backoffice_agent_group
    api_response = api_instance.backoffice_agent_group_list(organisation, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeAgentGroupApi->backofficeAgentGroupList: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeAgentGroupShow

show backoffice_agent_group

Get agent group


/0.0.1/backoffice/agent_groups/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/agent_groups/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeAgentGroupApi;

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

public class BackofficeAgentGroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeAgentGroupApi apiInstance = new BackofficeAgentGroupApi();
        String id = id_example; // String | Agent group ID
        String organisation = organisation_example; // String | 
        try {
            Agent_group result = apiInstance.backofficeAgentGroupShow(id, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAgentGroupApi#backofficeAgentGroupShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeAgentGroupApi;

public class BackofficeAgentGroupApiExample {

    public static void main(String[] args) {
        BackofficeAgentGroupApi apiInstance = new BackofficeAgentGroupApi();
        String id = id_example; // String | Agent group ID
        String organisation = organisation_example; // String | 
        try {
            Agent_group result = apiInstance.backofficeAgentGroupShow(id, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAgentGroupApi#backofficeAgentGroupShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Agent group ID
String *organisation = organisation_example; // 

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

// show backoffice_agent_group
[apiInstance backofficeAgentGroupShowWith:id
    organisation:organisation
              completionHandler: ^(Agent_group output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeAgentGroupApi()

var id = id_example; // {String} Agent group ID

var organisation = organisation_example; // {String} 

api.backofficeAgentGroupShow(id, organisation).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeAgentGroupShowExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeAgentGroupApi();
            var id = id_example;  // String | Agent group ID
            var organisation = organisation_example;  // String | 

            try
            {
                // show backoffice_agent_group
                Agent_group result = apiInstance.backofficeAgentGroupShow(id, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeAgentGroupApi.backofficeAgentGroupShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeAgentGroupApi();
$id = id_example; // String | Agent group ID
$organisation = organisation_example; // String | 

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

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeAgentGroupApi->new();
my $id = id_example; # String | Agent group ID
my $organisation = organisation_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeAgentGroupApi()
id = id_example # String | Agent group ID
organisation = organisation_example # String | 

try: 
    # show backoffice_agent_group
    api_response = api_instance.backoffice_agent_group_show(id, organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeAgentGroupApi->backofficeAgentGroupShow: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Agent group ID
Required
Header parameters
Name Description
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeAgentGroupUpdate

update backoffice_agent_group

Change agent group


/0.0.1/backoffice/agent_groups/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/agent_groups/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeAgentGroupApi;

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

public class BackofficeAgentGroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeAgentGroupApi apiInstance = new BackofficeAgentGroupApi();
        String id = id_example; // String | Agent group ID
        String organisation = organisation_example; // String | 
        AgentGroupPayload payload = ; // AgentGroupPayload | Agent group payload
        try {
            Agent result = apiInstance.backofficeAgentGroupUpdate(id, organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAgentGroupApi#backofficeAgentGroupUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeAgentGroupApi;

public class BackofficeAgentGroupApiExample {

    public static void main(String[] args) {
        BackofficeAgentGroupApi apiInstance = new BackofficeAgentGroupApi();
        String id = id_example; // String | Agent group ID
        String organisation = organisation_example; // String | 
        AgentGroupPayload payload = ; // AgentGroupPayload | Agent group payload
        try {
            Agent result = apiInstance.backofficeAgentGroupUpdate(id, organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAgentGroupApi#backofficeAgentGroupUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Agent group ID
String *organisation = organisation_example; // 
AgentGroupPayload *payload = ; // Agent group payload

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

// update backoffice_agent_group
[apiInstance backofficeAgentGroupUpdateWith:id
    organisation:organisation
    payload:payload
              completionHandler: ^(Agent output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeAgentGroupApi()

var id = id_example; // {String} Agent group ID

var organisation = organisation_example; // {String} 

var payload = ; // {AgentGroupPayload} Agent group payload

api.backofficeAgentGroupUpdate(id, organisation, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeAgentGroupUpdateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeAgentGroupApi();
            var id = id_example;  // String | Agent group ID
            var organisation = organisation_example;  // String | 
            var payload = new AgentGroupPayload(); // AgentGroupPayload | Agent group payload

            try
            {
                // update backoffice_agent_group
                Agent result = apiInstance.backofficeAgentGroupUpdate(id, organisation, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeAgentGroupApi.backofficeAgentGroupUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeAgentGroupApi();
$id = id_example; // String | Agent group ID
$organisation = organisation_example; // String | 
$payload = ; // AgentGroupPayload | Agent group payload

try {
    $result = $api_instance->backofficeAgentGroupUpdate($id, $organisation, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeAgentGroupApi->backofficeAgentGroupUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeAgentGroupApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeAgentGroupApi->new();
my $id = id_example; # String | Agent group ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::AgentGroupPayload->new(); # AgentGroupPayload | Agent group payload

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeAgentGroupApi()
id = id_example # String | Agent group ID
organisation = organisation_example # String | 
payload =  # AgentGroupPayload | Agent group payload

try: 
    # update backoffice_agent_group
    api_response = api_instance.backoffice_agent_group_update(id, organisation, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeAgentGroupApi->backofficeAgentGroupUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Agent group ID
Required
Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


BackofficeAuth

backofficeAuthConfirmPasswordReset

confirm_password_reset backoffice_auth

Confirm a password reset.


/0.0.1/backoffice/auth/confirm_password_reset

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/backoffice/auth/confirm_password_reset"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeAuthApi;

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

public class BackofficeAuthApiExample {

    public static void main(String[] args) {
        
        BackofficeAuthApi apiInstance = new BackofficeAuthApi();
        RequestPasswordResetConfirmPayload payload = ; // RequestPasswordResetConfirmPayload | A backoffice user password reset confirmation payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Authorized result = apiInstance.backofficeAuthConfirmPasswordReset(payload, acceptLanguage, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAuthApi#backofficeAuthConfirmPasswordReset");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeAuthApi;

public class BackofficeAuthApiExample {

    public static void main(String[] args) {
        BackofficeAuthApi apiInstance = new BackofficeAuthApi();
        RequestPasswordResetConfirmPayload payload = ; // RequestPasswordResetConfirmPayload | A backoffice user password reset confirmation payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Authorized result = apiInstance.backofficeAuthConfirmPasswordReset(payload, acceptLanguage, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAuthApi#backofficeAuthConfirmPasswordReset");
            e.printStackTrace();
        }
    }
}
RequestPasswordResetConfirmPayload *payload = ; // A backoffice user password reset confirmation payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// confirm_password_reset backoffice_auth
[apiInstance backofficeAuthConfirmPasswordResetWith:payload
    acceptLanguage:acceptLanguage
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(Authorized output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.BackofficeAuthApi()

var payload = ; // {RequestPasswordResetConfirmPayload} A backoffice user password reset confirmation payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeAuthConfirmPasswordReset(payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeAuthConfirmPasswordResetExample
    {
        public void main()
        {
            
            var apiInstance = new BackofficeAuthApi();
            var payload = new RequestPasswordResetConfirmPayload(); // RequestPasswordResetConfirmPayload | A backoffice user password reset confirmation payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // confirm_password_reset backoffice_auth
                Authorized result = apiInstance.backofficeAuthConfirmPasswordReset(payload, acceptLanguage, organisation, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeAuthApi.backofficeAuthConfirmPasswordReset: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BackofficeAuthApi();
$payload = ; // RequestPasswordResetConfirmPayload | A backoffice user password reset confirmation payload
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->backofficeAuthConfirmPasswordReset($payload, $acceptLanguage, $organisation, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeAuthApi->backofficeAuthConfirmPasswordReset: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeAuthApi;

my $api_instance = WWW::SwaggerClient::BackofficeAuthApi->new();
my $payload = WWW::SwaggerClient::Object::RequestPasswordResetConfirmPayload->new(); # RequestPasswordResetConfirmPayload | A backoffice user password reset confirmation payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->backofficeAuthConfirmPasswordReset(payload => $payload, acceptLanguage => $acceptLanguage, organisation => $organisation, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeAuthApi->backofficeAuthConfirmPasswordReset: $@\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.BackofficeAuthApi()
payload =  # RequestPasswordResetConfirmPayload | A backoffice user password reset confirmation payload
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # confirm_password_reset backoffice_auth
    api_response = api_instance.backoffice_auth_confirm_password_reset(payload, acceptLanguage=acceptLanguage, organisation=organisation, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeAuthApi->backofficeAuthConfirmPasswordReset: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Organisation
String
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Name Type Format Description
Authorization String Generated JWT
Authorization-Token-Expires String Expiration of the authorization token

Status: 400 - Bad Request


backofficeAuthExtend

extend backoffice_auth

Backoffice extend auth token


/0.0.1/backoffice/auth/extend

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/auth/extend"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeAuthApi;

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

public class BackofficeAuthApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeAuthApi apiInstance = new BackofficeAuthApi();
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Authorized result = apiInstance.backofficeAuthExtend(acceptLanguage, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAuthApi#backofficeAuthExtend");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeAuthApi;

public class BackofficeAuthApiExample {

    public static void main(String[] args) {
        BackofficeAuthApi apiInstance = new BackofficeAuthApi();
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Authorized result = apiInstance.backofficeAuthExtend(acceptLanguage, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAuthApi#backofficeAuthExtend");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// extend backoffice_auth
[apiInstance backofficeAuthExtendWith:acceptLanguage
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(Authorized output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeAuthApi()

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeAuthExtend(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeAuthExtendExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeAuthApi();
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // extend backoffice_auth
                Authorized result = apiInstance.backofficeAuthExtend(acceptLanguage, organisation, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeAuthApi.backofficeAuthExtend: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeAuthApi();
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->backofficeAuthExtend($acceptLanguage, $organisation, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeAuthApi->backofficeAuthExtend: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeAuthApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeAuthApi->new();
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->backofficeAuthExtend(acceptLanguage => $acceptLanguage, organisation => $organisation, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeAuthApi->backofficeAuthExtend: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeAuthApi()
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # extend backoffice_auth
    api_response = api_instance.backoffice_auth_extend(acceptLanguage=acceptLanguage, organisation=organisation, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeAuthApi->backofficeAuthExtend: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Organisation
String
X-Forwarded-For
String

Responses

Status: 200 - OK

Name Type Format Description
Authorization String Generated JWT
Authorization-Token-Expires String Expiration of the authorization token

Status: 400 - Bad Request

Status: 401 - Unauthorized


backofficeAuthLogin

login backoffice_auth

Backoffice login


/0.0.1/backoffice/login

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/backoffice/login"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeAuthApi;

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

public class BackofficeAuthApiExample {

    public static void main(String[] args) {
        
        BackofficeAuthApi apiInstance = new BackofficeAuthApi();
        LoginBackofficeAuthPayload payload = ; // LoginBackofficeAuthPayload | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Authorized result = apiInstance.backofficeAuthLogin(payload, acceptLanguage, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAuthApi#backofficeAuthLogin");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeAuthApi;

public class BackofficeAuthApiExample {

    public static void main(String[] args) {
        BackofficeAuthApi apiInstance = new BackofficeAuthApi();
        LoginBackofficeAuthPayload payload = ; // LoginBackofficeAuthPayload | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Authorized result = apiInstance.backofficeAuthLogin(payload, acceptLanguage, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAuthApi#backofficeAuthLogin");
            e.printStackTrace();
        }
    }
}
LoginBackofficeAuthPayload *payload = ; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// login backoffice_auth
[apiInstance backofficeAuthLoginWith:payload
    acceptLanguage:acceptLanguage
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(Authorized output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.BackofficeAuthApi()

var payload = ; // {LoginBackofficeAuthPayload} 

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeAuthLogin(payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeAuthLoginExample
    {
        public void main()
        {
            
            var apiInstance = new BackofficeAuthApi();
            var payload = new LoginBackofficeAuthPayload(); // LoginBackofficeAuthPayload | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // login backoffice_auth
                Authorized result = apiInstance.backofficeAuthLogin(payload, acceptLanguage, organisation, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeAuthApi.backofficeAuthLogin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BackofficeAuthApi();
$payload = ; // LoginBackofficeAuthPayload | 
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->backofficeAuthLogin($payload, $acceptLanguage, $organisation, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeAuthApi->backofficeAuthLogin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeAuthApi;

my $api_instance = WWW::SwaggerClient::BackofficeAuthApi->new();
my $payload = WWW::SwaggerClient::Object::LoginBackofficeAuthPayload->new(); # LoginBackofficeAuthPayload | 
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->backofficeAuthLogin(payload => $payload, acceptLanguage => $acceptLanguage, organisation => $organisation, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeAuthApi->backofficeAuthLogin: $@\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.BackofficeAuthApi()
payload =  # LoginBackofficeAuthPayload | 
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # login backoffice_auth
    api_response = api_instance.backoffice_auth_login(payload, acceptLanguage=acceptLanguage, organisation=organisation, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeAuthApi->backofficeAuthLogin: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Organisation
String
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Name Type Format Description
Authorization String Generated JWT
Authorization-Token-Expires String Expiration of the authorization token

Status: 400 - Bad Request

Status: 401 - Unauthorized


backofficeAuthLoginOauthCallback

login_oauth_callback backoffice_auth

Backoffice login oauth callback


/0.0.1/backoffice/login_oauth_callback/{provider}

Usage and SDK Samples

curl -X GET "https://api.quriobot.com/0.0.1/backoffice/login_oauth_callback/{provider}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeAuthApi;

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

public class BackofficeAuthApiExample {

    public static void main(String[] args) {
        
        BackofficeAuthApi apiInstance = new BackofficeAuthApi();
        String provider = provider_example; // String | OAauth provider name
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            apiInstance.backofficeAuthLoginOauthCallback(provider, acceptLanguage, organisation, xForwardedFor);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAuthApi#backofficeAuthLoginOauthCallback");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeAuthApi;

public class BackofficeAuthApiExample {

    public static void main(String[] args) {
        BackofficeAuthApi apiInstance = new BackofficeAuthApi();
        String provider = provider_example; // String | OAauth provider name
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            apiInstance.backofficeAuthLoginOauthCallback(provider, acceptLanguage, organisation, xForwardedFor);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAuthApi#backofficeAuthLoginOauthCallback");
            e.printStackTrace();
        }
    }
}
String *provider = provider_example; // OAauth provider name
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// login_oauth_callback backoffice_auth
[apiInstance backofficeAuthLoginOauthCallbackWith:provider
    acceptLanguage:acceptLanguage
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.BackofficeAuthApi()

var provider = provider_example; // {String} OAauth provider name

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeAuthLoginOauthCallback(provider, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeAuthLoginOauthCallbackExample
    {
        public void main()
        {
            
            var apiInstance = new BackofficeAuthApi();
            var provider = provider_example;  // String | OAauth provider name
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // login_oauth_callback backoffice_auth
                apiInstance.backofficeAuthLoginOauthCallback(provider, acceptLanguage, organisation, xForwardedFor);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeAuthApi.backofficeAuthLoginOauthCallback: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BackofficeAuthApi();
$provider = provider_example; // String | OAauth provider name
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $api_instance->backofficeAuthLoginOauthCallback($provider, $acceptLanguage, $organisation, $xForwardedFor);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeAuthApi->backofficeAuthLoginOauthCallback: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeAuthApi;

my $api_instance = WWW::SwaggerClient::BackofficeAuthApi->new();
my $provider = provider_example; # String | OAauth provider name
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    $api_instance->backofficeAuthLoginOauthCallback(provider => $provider, acceptLanguage => $acceptLanguage, organisation => $organisation, xForwardedFor => $xForwardedFor);
};
if ($@) {
    warn "Exception when calling BackofficeAuthApi->backofficeAuthLoginOauthCallback: $@\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.BackofficeAuthApi()
provider = provider_example # String | OAauth provider name
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # login_oauth_callback backoffice_auth
    api_instance.backoffice_auth_login_oauth_callback(provider, acceptLanguage=acceptLanguage, organisation=organisation, xForwardedFor=xForwardedFor)
except ApiException as e:
    print("Exception when calling BackofficeAuthApi->backofficeAuthLoginOauthCallback: %s\n" % e)

Parameters

Path parameters
Name Description
provider*
String
OAauth provider name
Required
Header parameters
Name Description
Accept-Language
String
Organisation
String
X-Forwarded-For
String

Responses

Status: 302 - Redirect

Status: 400 - Bad Request

Status: 401 - Unauthorized


backofficeAuthLoginOauthConfirm

login_oauth_confirm backoffice_auth

Confirm backoffice oauth user registration


/0.0.1/backoffice/login_oauth_callback/confirm

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/backoffice/login_oauth_callback/confirm"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeAuthApi;

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

public class BackofficeAuthApiExample {

    public static void main(String[] args) {
        
        BackofficeAuthApi apiInstance = new BackofficeAuthApi();
        LoginOAuthCallbackConfirmPayload payload = ; // LoginOAuthCallbackConfirmPayload | A login oauth callback confirm payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Authorized result = apiInstance.backofficeAuthLoginOauthConfirm(payload, acceptLanguage, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAuthApi#backofficeAuthLoginOauthConfirm");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeAuthApi;

public class BackofficeAuthApiExample {

    public static void main(String[] args) {
        BackofficeAuthApi apiInstance = new BackofficeAuthApi();
        LoginOAuthCallbackConfirmPayload payload = ; // LoginOAuthCallbackConfirmPayload | A login oauth callback confirm payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Authorized result = apiInstance.backofficeAuthLoginOauthConfirm(payload, acceptLanguage, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAuthApi#backofficeAuthLoginOauthConfirm");
            e.printStackTrace();
        }
    }
}
LoginOAuthCallbackConfirmPayload *payload = ; // A login oauth callback confirm payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// login_oauth_confirm backoffice_auth
[apiInstance backofficeAuthLoginOauthConfirmWith:payload
    acceptLanguage:acceptLanguage
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(Authorized output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.BackofficeAuthApi()

var payload = ; // {LoginOAuthCallbackConfirmPayload} A login oauth callback confirm payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeAuthLoginOauthConfirm(payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeAuthLoginOauthConfirmExample
    {
        public void main()
        {
            
            var apiInstance = new BackofficeAuthApi();
            var payload = new LoginOAuthCallbackConfirmPayload(); // LoginOAuthCallbackConfirmPayload | A login oauth callback confirm payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // login_oauth_confirm backoffice_auth
                Authorized result = apiInstance.backofficeAuthLoginOauthConfirm(payload, acceptLanguage, organisation, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeAuthApi.backofficeAuthLoginOauthConfirm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BackofficeAuthApi();
$payload = ; // LoginOAuthCallbackConfirmPayload | A login oauth callback confirm payload
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->backofficeAuthLoginOauthConfirm($payload, $acceptLanguage, $organisation, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeAuthApi->backofficeAuthLoginOauthConfirm: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeAuthApi;

my $api_instance = WWW::SwaggerClient::BackofficeAuthApi->new();
my $payload = WWW::SwaggerClient::Object::LoginOAuthCallbackConfirmPayload->new(); # LoginOAuthCallbackConfirmPayload | A login oauth callback confirm payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->backofficeAuthLoginOauthConfirm(payload => $payload, acceptLanguage => $acceptLanguage, organisation => $organisation, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeAuthApi->backofficeAuthLoginOauthConfirm: $@\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.BackofficeAuthApi()
payload =  # LoginOAuthCallbackConfirmPayload | A login oauth callback confirm payload
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # login_oauth_confirm backoffice_auth
    api_response = api_instance.backoffice_auth_login_oauth_confirm(payload, acceptLanguage=acceptLanguage, organisation=organisation, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeAuthApi->backofficeAuthLoginOauthConfirm: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Organisation
String
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Name Type Format Description
Authorization String Generated JWT
Authorization-Token-Expires String Expiration of the authorization token

Status: 400 - Bad Request


backofficeAuthLoginOauthRequest

login_oauth_request backoffice_auth

Backoffice login oauth request


/0.0.1/backoffice/login_oauth_request/{provider}/{recaptcha_response}

Usage and SDK Samples

curl -X GET "https://api.quriobot.com/0.0.1/backoffice/login_oauth_request/{provider}/{recaptcha_response}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeAuthApi;

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

public class BackofficeAuthApiExample {

    public static void main(String[] args) {
        
        BackofficeAuthApi apiInstance = new BackofficeAuthApi();
        String provider = provider_example; // String | OAauth provider name
        String recaptchaResponse = recaptchaResponse_example; // String | Recaptcha response
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        LoginOauthPayload payload = ; // LoginOauthPayload | A backoffice oauth login payload
        try {
            apiInstance.backofficeAuthLoginOauthRequest(provider, recaptchaResponse, acceptLanguage, organisation, xForwardedFor, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAuthApi#backofficeAuthLoginOauthRequest");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeAuthApi;

public class BackofficeAuthApiExample {

    public static void main(String[] args) {
        BackofficeAuthApi apiInstance = new BackofficeAuthApi();
        String provider = provider_example; // String | OAauth provider name
        String recaptchaResponse = recaptchaResponse_example; // String | Recaptcha response
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        LoginOauthPayload payload = ; // LoginOauthPayload | A backoffice oauth login payload
        try {
            apiInstance.backofficeAuthLoginOauthRequest(provider, recaptchaResponse, acceptLanguage, organisation, xForwardedFor, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAuthApi#backofficeAuthLoginOauthRequest");
            e.printStackTrace();
        }
    }
}
String *provider = provider_example; // OAauth provider name
String *recaptchaResponse = recaptchaResponse_example; // Recaptcha response
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)
LoginOauthPayload *payload = ; // A backoffice oauth login payload (optional)

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

// login_oauth_request backoffice_auth
[apiInstance backofficeAuthLoginOauthRequestWith:provider
    recaptchaResponse:recaptchaResponse
    acceptLanguage:acceptLanguage
    organisation:organisation
    xForwardedFor:xForwardedFor
    payload:payload
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.BackofficeAuthApi()

var provider = provider_example; // {String} OAauth provider name

var recaptchaResponse = recaptchaResponse_example; // {String} Recaptcha response

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example, // {String} 
  'payload':  // {LoginOauthPayload} A backoffice oauth login payload
};
api.backofficeAuthLoginOauthRequest(provider, recaptchaResponse, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeAuthLoginOauthRequestExample
    {
        public void main()
        {
            
            var apiInstance = new BackofficeAuthApi();
            var provider = provider_example;  // String | OAauth provider name
            var recaptchaResponse = recaptchaResponse_example;  // String | Recaptcha response
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 
            var payload = new LoginOauthPayload(); // LoginOauthPayload | A backoffice oauth login payload (optional) 

            try
            {
                // login_oauth_request backoffice_auth
                apiInstance.backofficeAuthLoginOauthRequest(provider, recaptchaResponse, acceptLanguage, organisation, xForwardedFor, payload);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeAuthApi.backofficeAuthLoginOauthRequest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BackofficeAuthApi();
$provider = provider_example; // String | OAauth provider name
$recaptchaResponse = recaptchaResponse_example; // String | Recaptcha response
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 
$payload = ; // LoginOauthPayload | A backoffice oauth login payload

try {
    $api_instance->backofficeAuthLoginOauthRequest($provider, $recaptchaResponse, $acceptLanguage, $organisation, $xForwardedFor, $payload);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeAuthApi->backofficeAuthLoginOauthRequest: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeAuthApi;

my $api_instance = WWW::SwaggerClient::BackofficeAuthApi->new();
my $provider = provider_example; # String | OAauth provider name
my $recaptchaResponse = recaptchaResponse_example; # String | Recaptcha response
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 
my $payload = WWW::SwaggerClient::Object::LoginOauthPayload->new(); # LoginOauthPayload | A backoffice oauth login payload

eval { 
    $api_instance->backofficeAuthLoginOauthRequest(provider => $provider, recaptchaResponse => $recaptchaResponse, acceptLanguage => $acceptLanguage, organisation => $organisation, xForwardedFor => $xForwardedFor, payload => $payload);
};
if ($@) {
    warn "Exception when calling BackofficeAuthApi->backofficeAuthLoginOauthRequest: $@\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.BackofficeAuthApi()
provider = provider_example # String | OAauth provider name
recaptchaResponse = recaptchaResponse_example # String | Recaptcha response
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)
payload =  # LoginOauthPayload | A backoffice oauth login payload (optional)

try: 
    # login_oauth_request backoffice_auth
    api_instance.backoffice_auth_login_oauth_request(provider, recaptchaResponse, acceptLanguage=acceptLanguage, organisation=organisation, xForwardedFor=xForwardedFor, payload=payload)
except ApiException as e:
    print("Exception when calling BackofficeAuthApi->backofficeAuthLoginOauthRequest: %s\n" % e)

Parameters

Path parameters
Name Description
provider*
String
OAauth provider name
Required
recaptcha_response*
String
Recaptcha response
Required
Header parameters
Name Description
Accept-Language
String
Organisation
String
X-Forwarded-For
String
Body parameters
Name Description
payload

Responses

Status: 302 - Redirect

Status: 400 - Bad Request

Status: 401 - Unauthorized


backofficeAuthLoginToken

login_token backoffice_auth

Backoffice login by token


/0.0.1/backoffice/login_token

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/backoffice/login_token"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeAuthApi;

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

public class BackofficeAuthApiExample {

    public static void main(String[] args) {
        
        BackofficeAuthApi apiInstance = new BackofficeAuthApi();
        LoginTokenBackofficeAuthPayload payload = ; // LoginTokenBackofficeAuthPayload | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Authorized result = apiInstance.backofficeAuthLoginToken(payload, acceptLanguage, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAuthApi#backofficeAuthLoginToken");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeAuthApi;

public class BackofficeAuthApiExample {

    public static void main(String[] args) {
        BackofficeAuthApi apiInstance = new BackofficeAuthApi();
        LoginTokenBackofficeAuthPayload payload = ; // LoginTokenBackofficeAuthPayload | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Authorized result = apiInstance.backofficeAuthLoginToken(payload, acceptLanguage, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAuthApi#backofficeAuthLoginToken");
            e.printStackTrace();
        }
    }
}
LoginTokenBackofficeAuthPayload *payload = ; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// login_token backoffice_auth
[apiInstance backofficeAuthLoginTokenWith:payload
    acceptLanguage:acceptLanguage
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(Authorized output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.BackofficeAuthApi()

var payload = ; // {LoginTokenBackofficeAuthPayload} 

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeAuthLoginToken(payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeAuthLoginTokenExample
    {
        public void main()
        {
            
            var apiInstance = new BackofficeAuthApi();
            var payload = new LoginTokenBackofficeAuthPayload(); // LoginTokenBackofficeAuthPayload | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // login_token backoffice_auth
                Authorized result = apiInstance.backofficeAuthLoginToken(payload, acceptLanguage, organisation, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeAuthApi.backofficeAuthLoginToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BackofficeAuthApi();
$payload = ; // LoginTokenBackofficeAuthPayload | 
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->backofficeAuthLoginToken($payload, $acceptLanguage, $organisation, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeAuthApi->backofficeAuthLoginToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeAuthApi;

my $api_instance = WWW::SwaggerClient::BackofficeAuthApi->new();
my $payload = WWW::SwaggerClient::Object::LoginTokenBackofficeAuthPayload->new(); # LoginTokenBackofficeAuthPayload | 
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->backofficeAuthLoginToken(payload => $payload, acceptLanguage => $acceptLanguage, organisation => $organisation, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeAuthApi->backofficeAuthLoginToken: $@\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.BackofficeAuthApi()
payload =  # LoginTokenBackofficeAuthPayload | 
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # login_token backoffice_auth
    api_response = api_instance.backoffice_auth_login_token(payload, acceptLanguage=acceptLanguage, organisation=organisation, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeAuthApi->backofficeAuthLoginToken: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Organisation
String
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Name Type Format Description
Authorization String Generated JWT
Authorization-Token-Expires String Expiration of the authorization token

Status: 400 - Bad Request

Status: 401 - Unauthorized


backofficeAuthLogout

logout backoffice_auth

Backoffice logout


/0.0.1/backoffice/logout

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/logout"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeAuthApi;

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

public class BackofficeAuthApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeAuthApi apiInstance = new BackofficeAuthApi();
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            apiInstance.backofficeAuthLogout(acceptLanguage, organisation, xForwardedFor);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAuthApi#backofficeAuthLogout");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeAuthApi;

public class BackofficeAuthApiExample {

    public static void main(String[] args) {
        BackofficeAuthApi apiInstance = new BackofficeAuthApi();
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            apiInstance.backofficeAuthLogout(acceptLanguage, organisation, xForwardedFor);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAuthApi#backofficeAuthLogout");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// logout backoffice_auth
[apiInstance backofficeAuthLogoutWith:acceptLanguage
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeAuthApi()

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeAuthLogout(opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeAuthLogoutExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeAuthApi();
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // logout backoffice_auth
                apiInstance.backofficeAuthLogout(acceptLanguage, organisation, xForwardedFor);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeAuthApi.backofficeAuthLogout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeAuthApi();
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $api_instance->backofficeAuthLogout($acceptLanguage, $organisation, $xForwardedFor);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeAuthApi->backofficeAuthLogout: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeAuthApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeAuthApi->new();
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    $api_instance->backofficeAuthLogout(acceptLanguage => $acceptLanguage, organisation => $organisation, xForwardedFor => $xForwardedFor);
};
if ($@) {
    warn "Exception when calling BackofficeAuthApi->backofficeAuthLogout: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeAuthApi()
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # logout backoffice_auth
    api_instance.backoffice_auth_logout(acceptLanguage=acceptLanguage, organisation=organisation, xForwardedFor=xForwardedFor)
except ApiException as e:
    print("Exception when calling BackofficeAuthApi->backofficeAuthLogout: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Organisation
String
X-Forwarded-For
String

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized


backofficeAuthRecaptcha

recaptcha backoffice_auth

Recaptcha for login


/0.0.1/backoffice/recaptcha

Usage and SDK Samples

curl -X GET "https://api.quriobot.com/0.0.1/backoffice/recaptcha"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeAuthApi;

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

public class BackofficeAuthApiExample {

    public static void main(String[] args) {
        
        BackofficeAuthApi apiInstance = new BackofficeAuthApi();
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Recaptcha result = apiInstance.backofficeAuthRecaptcha(acceptLanguage, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAuthApi#backofficeAuthRecaptcha");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeAuthApi;

public class BackofficeAuthApiExample {

    public static void main(String[] args) {
        BackofficeAuthApi apiInstance = new BackofficeAuthApi();
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Recaptcha result = apiInstance.backofficeAuthRecaptcha(acceptLanguage, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAuthApi#backofficeAuthRecaptcha");
            e.printStackTrace();
        }
    }
}
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// recaptcha backoffice_auth
[apiInstance backofficeAuthRecaptchaWith:acceptLanguage
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(Recaptcha output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.BackofficeAuthApi()

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeAuthRecaptcha(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeAuthRecaptchaExample
    {
        public void main()
        {
            
            var apiInstance = new BackofficeAuthApi();
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // recaptcha backoffice_auth
                Recaptcha result = apiInstance.backofficeAuthRecaptcha(acceptLanguage, organisation, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeAuthApi.backofficeAuthRecaptcha: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BackofficeAuthApi();
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->backofficeAuthRecaptcha($acceptLanguage, $organisation, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeAuthApi->backofficeAuthRecaptcha: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeAuthApi;

my $api_instance = WWW::SwaggerClient::BackofficeAuthApi->new();
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->backofficeAuthRecaptcha(acceptLanguage => $acceptLanguage, organisation => $organisation, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeAuthApi->backofficeAuthRecaptcha: $@\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.BackofficeAuthApi()
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # recaptcha backoffice_auth
    api_response = api_instance.backoffice_auth_recaptcha(acceptLanguage=acceptLanguage, organisation=organisation, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeAuthApi->backofficeAuthRecaptcha: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Organisation
String
X-Forwarded-For
String

Responses

Status: 200 - OK


backofficeAuthRequestPasswordReset

request_password_reset backoffice_auth

Request a password reset.


/0.0.1/backoffice/auth/request_password_reset

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/backoffice/auth/request_password_reset"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeAuthApi;

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

public class BackofficeAuthApiExample {

    public static void main(String[] args) {
        
        BackofficeAuthApi apiInstance = new BackofficeAuthApi();
        RequestPasswordResetRequestPayload payload = ; // RequestPasswordResetRequestPayload | A backoffice user password reset request payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            apiInstance.backofficeAuthRequestPasswordReset(payload, acceptLanguage, organisation, xForwardedFor);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAuthApi#backofficeAuthRequestPasswordReset");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeAuthApi;

public class BackofficeAuthApiExample {

    public static void main(String[] args) {
        BackofficeAuthApi apiInstance = new BackofficeAuthApi();
        RequestPasswordResetRequestPayload payload = ; // RequestPasswordResetRequestPayload | A backoffice user password reset request payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            apiInstance.backofficeAuthRequestPasswordReset(payload, acceptLanguage, organisation, xForwardedFor);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAuthApi#backofficeAuthRequestPasswordReset");
            e.printStackTrace();
        }
    }
}
RequestPasswordResetRequestPayload *payload = ; // A backoffice user password reset request payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// request_password_reset backoffice_auth
[apiInstance backofficeAuthRequestPasswordResetWith:payload
    acceptLanguage:acceptLanguage
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.BackofficeAuthApi()

var payload = ; // {RequestPasswordResetRequestPayload} A backoffice user password reset request payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeAuthRequestPasswordReset(payload, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeAuthRequestPasswordResetExample
    {
        public void main()
        {
            
            var apiInstance = new BackofficeAuthApi();
            var payload = new RequestPasswordResetRequestPayload(); // RequestPasswordResetRequestPayload | A backoffice user password reset request payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // request_password_reset backoffice_auth
                apiInstance.backofficeAuthRequestPasswordReset(payload, acceptLanguage, organisation, xForwardedFor);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeAuthApi.backofficeAuthRequestPasswordReset: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BackofficeAuthApi();
$payload = ; // RequestPasswordResetRequestPayload | A backoffice user password reset request payload
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $api_instance->backofficeAuthRequestPasswordReset($payload, $acceptLanguage, $organisation, $xForwardedFor);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeAuthApi->backofficeAuthRequestPasswordReset: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeAuthApi;

my $api_instance = WWW::SwaggerClient::BackofficeAuthApi->new();
my $payload = WWW::SwaggerClient::Object::RequestPasswordResetRequestPayload->new(); # RequestPasswordResetRequestPayload | A backoffice user password reset request payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    $api_instance->backofficeAuthRequestPasswordReset(payload => $payload, acceptLanguage => $acceptLanguage, organisation => $organisation, xForwardedFor => $xForwardedFor);
};
if ($@) {
    warn "Exception when calling BackofficeAuthApi->backofficeAuthRequestPasswordReset: $@\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.BackofficeAuthApi()
payload =  # RequestPasswordResetRequestPayload | A backoffice user password reset request payload
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # request_password_reset backoffice_auth
    api_instance.backoffice_auth_request_password_reset(payload, acceptLanguage=acceptLanguage, organisation=organisation, xForwardedFor=xForwardedFor)
except ApiException as e:
    print("Exception when calling BackofficeAuthApi->backofficeAuthRequestPasswordReset: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Organisation
String
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 404 - Not Found


BackofficeAutocomplete

backofficeAutocompleteList

list backoffice_autocomplete

List autocomplete items


/0.0.1/backoffice/autocomplete/{name}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/autocomplete/{name}?variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeAutocompleteApi;

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

public class BackofficeAutocompleteApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeAutocompleteApi apiInstance = new BackofficeAutocompleteApi();
        String name = name_example; // String | Autocomplete entity name
        AutoCompleteItemCollectionPayload payload = ; // AutoCompleteItemCollectionPayload | Auto complete item collection payload
        String variant = variant_example; // String | Autocomplete entity variant
        String acceptLanguage = acceptLanguage_example; // String | 
        String account = account_example; // String | 
        String bot = bot_example; // String | 
        String botStep = botStep_example; // String | 
        String channel = channel_example; // String | 
        String contact = contact_example; // String | 
        String integration = integration_example; // String | 
        String integrationGoogleDriveDocument = integrationGoogleDriveDocument_example; // String | 
        String integrationGoogleDriveDocumentType = integrationGoogleDriveDocumentType_example; // String | 
        String integrationType = integrationType_example; // String | 
        String knowledgeBase = knowledgeBase_example; // String | 
        String organisation = organisation_example; // String | 
        String page = page_example; // String | 
        String permission = permission_example; // String | Permission to check for an entity
        try {
            Autocomplete_item_collection result = apiInstance.backofficeAutocompleteList(name, payload, variant, acceptLanguage, account, bot, botStep, channel, contact, integration, integrationGoogleDriveDocument, integrationGoogleDriveDocumentType, integrationType, knowledgeBase, organisation, page, permission);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAutocompleteApi#backofficeAutocompleteList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeAutocompleteApi;

public class BackofficeAutocompleteApiExample {

    public static void main(String[] args) {
        BackofficeAutocompleteApi apiInstance = new BackofficeAutocompleteApi();
        String name = name_example; // String | Autocomplete entity name
        AutoCompleteItemCollectionPayload payload = ; // AutoCompleteItemCollectionPayload | Auto complete item collection payload
        String variant = variant_example; // String | Autocomplete entity variant
        String acceptLanguage = acceptLanguage_example; // String | 
        String account = account_example; // String | 
        String bot = bot_example; // String | 
        String botStep = botStep_example; // String | 
        String channel = channel_example; // String | 
        String contact = contact_example; // String | 
        String integration = integration_example; // String | 
        String integrationGoogleDriveDocument = integrationGoogleDriveDocument_example; // String | 
        String integrationGoogleDriveDocumentType = integrationGoogleDriveDocumentType_example; // String | 
        String integrationType = integrationType_example; // String | 
        String knowledgeBase = knowledgeBase_example; // String | 
        String organisation = organisation_example; // String | 
        String page = page_example; // String | 
        String permission = permission_example; // String | Permission to check for an entity
        try {
            Autocomplete_item_collection result = apiInstance.backofficeAutocompleteList(name, payload, variant, acceptLanguage, account, bot, botStep, channel, contact, integration, integrationGoogleDriveDocument, integrationGoogleDriveDocumentType, integrationType, knowledgeBase, organisation, page, permission);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAutocompleteApi#backofficeAutocompleteList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *name = name_example; // Autocomplete entity name
AutoCompleteItemCollectionPayload *payload = ; // Auto complete item collection payload
String *variant = variant_example; // Autocomplete entity variant (optional)
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *account = account_example; //  (optional)
String *bot = bot_example; //  (optional)
String *botStep = botStep_example; //  (optional)
String *channel = channel_example; //  (optional)
String *contact = contact_example; //  (optional)
String *integration = integration_example; //  (optional)
String *integrationGoogleDriveDocument = integrationGoogleDriveDocument_example; //  (optional)
String *integrationGoogleDriveDocumentType = integrationGoogleDriveDocumentType_example; //  (optional)
String *integrationType = integrationType_example; //  (optional)
String *knowledgeBase = knowledgeBase_example; //  (optional)
String *organisation = organisation_example; //  (optional)
String *page = page_example; //  (optional)
String *permission = permission_example; // Permission to check for an entity (optional)

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

// list backoffice_autocomplete
[apiInstance backofficeAutocompleteListWith:name
    payload:payload
    variant:variant
    acceptLanguage:acceptLanguage
    account:account
    bot:bot
    botStep:botStep
    channel:channel
    contact:contact
    integration:integration
    integrationGoogleDriveDocument:integrationGoogleDriveDocument
    integrationGoogleDriveDocumentType:integrationGoogleDriveDocumentType
    integrationType:integrationType
    knowledgeBase:knowledgeBase
    organisation:organisation
    page:page
    permission:permission
              completionHandler: ^(Autocomplete_item_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeAutocompleteApi()

var name = name_example; // {String} Autocomplete entity name

var payload = ; // {AutoCompleteItemCollectionPayload} Auto complete item collection payload

var opts = { 
  'variant': variant_example, // {String} Autocomplete entity variant
  'acceptLanguage': acceptLanguage_example, // {String} 
  'account': account_example, // {String} 
  'bot': bot_example, // {String} 
  'botStep': botStep_example, // {String} 
  'channel': channel_example, // {String} 
  'contact': contact_example, // {String} 
  'integration': integration_example, // {String} 
  'integrationGoogleDriveDocument': integrationGoogleDriveDocument_example, // {String} 
  'integrationGoogleDriveDocumentType': integrationGoogleDriveDocumentType_example, // {String} 
  'integrationType': integrationType_example, // {String} 
  'knowledgeBase': knowledgeBase_example, // {String} 
  'organisation': organisation_example, // {String} 
  'page': page_example, // {String} 
  'permission': permission_example // {String} Permission to check for an entity
};
api.backofficeAutocompleteList(name, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeAutocompleteListExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeAutocompleteApi();
            var name = name_example;  // String | Autocomplete entity name
            var payload = new AutoCompleteItemCollectionPayload(); // AutoCompleteItemCollectionPayload | Auto complete item collection payload
            var variant = variant_example;  // String | Autocomplete entity variant (optional) 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var account = account_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var botStep = botStep_example;  // String |  (optional) 
            var channel = channel_example;  // String |  (optional) 
            var contact = contact_example;  // String |  (optional) 
            var integration = integration_example;  // String |  (optional) 
            var integrationGoogleDriveDocument = integrationGoogleDriveDocument_example;  // String |  (optional) 
            var integrationGoogleDriveDocumentType = integrationGoogleDriveDocumentType_example;  // String |  (optional) 
            var integrationType = integrationType_example;  // String |  (optional) 
            var knowledgeBase = knowledgeBase_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 
            var page = page_example;  // String |  (optional) 
            var permission = permission_example;  // String | Permission to check for an entity (optional) 

            try
            {
                // list backoffice_autocomplete
                Autocomplete_item_collection result = apiInstance.backofficeAutocompleteList(name, payload, variant, acceptLanguage, account, bot, botStep, channel, contact, integration, integrationGoogleDriveDocument, integrationGoogleDriveDocumentType, integrationType, knowledgeBase, organisation, page, permission);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeAutocompleteApi.backofficeAutocompleteList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeAutocompleteApi();
$name = name_example; // String | Autocomplete entity name
$payload = ; // AutoCompleteItemCollectionPayload | Auto complete item collection payload
$variant = variant_example; // String | Autocomplete entity variant
$acceptLanguage = acceptLanguage_example; // String | 
$account = account_example; // String | 
$bot = bot_example; // String | 
$botStep = botStep_example; // String | 
$channel = channel_example; // String | 
$contact = contact_example; // String | 
$integration = integration_example; // String | 
$integrationGoogleDriveDocument = integrationGoogleDriveDocument_example; // String | 
$integrationGoogleDriveDocumentType = integrationGoogleDriveDocumentType_example; // String | 
$integrationType = integrationType_example; // String | 
$knowledgeBase = knowledgeBase_example; // String | 
$organisation = organisation_example; // String | 
$page = page_example; // String | 
$permission = permission_example; // String | Permission to check for an entity

try {
    $result = $api_instance->backofficeAutocompleteList($name, $payload, $variant, $acceptLanguage, $account, $bot, $botStep, $channel, $contact, $integration, $integrationGoogleDriveDocument, $integrationGoogleDriveDocumentType, $integrationType, $knowledgeBase, $organisation, $page, $permission);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeAutocompleteApi->backofficeAutocompleteList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeAutocompleteApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeAutocompleteApi->new();
my $name = name_example; # String | Autocomplete entity name
my $payload = WWW::SwaggerClient::Object::AutoCompleteItemCollectionPayload->new(); # AutoCompleteItemCollectionPayload | Auto complete item collection payload
my $variant = variant_example; # String | Autocomplete entity variant
my $acceptLanguage = acceptLanguage_example; # String | 
my $account = account_example; # String | 
my $bot = bot_example; # String | 
my $botStep = botStep_example; # String | 
my $channel = channel_example; # String | 
my $contact = contact_example; # String | 
my $integration = integration_example; # String | 
my $integrationGoogleDriveDocument = integrationGoogleDriveDocument_example; # String | 
my $integrationGoogleDriveDocumentType = integrationGoogleDriveDocumentType_example; # String | 
my $integrationType = integrationType_example; # String | 
my $knowledgeBase = knowledgeBase_example; # String | 
my $organisation = organisation_example; # String | 
my $page = page_example; # String | 
my $permission = permission_example; # String | Permission to check for an entity

eval { 
    my $result = $api_instance->backofficeAutocompleteList(name => $name, payload => $payload, variant => $variant, acceptLanguage => $acceptLanguage, account => $account, bot => $bot, botStep => $botStep, channel => $channel, contact => $contact, integration => $integration, integrationGoogleDriveDocument => $integrationGoogleDriveDocument, integrationGoogleDriveDocumentType => $integrationGoogleDriveDocumentType, integrationType => $integrationType, knowledgeBase => $knowledgeBase, organisation => $organisation, page => $page, permission => $permission);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeAutocompleteApi->backofficeAutocompleteList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeAutocompleteApi()
name = name_example # String | Autocomplete entity name
payload =  # AutoCompleteItemCollectionPayload | Auto complete item collection payload
variant = variant_example # String | Autocomplete entity variant (optional)
acceptLanguage = acceptLanguage_example # String |  (optional)
account = account_example # String |  (optional)
bot = bot_example # String |  (optional)
botStep = botStep_example # String |  (optional)
channel = channel_example # String |  (optional)
contact = contact_example # String |  (optional)
integration = integration_example # String |  (optional)
integrationGoogleDriveDocument = integrationGoogleDriveDocument_example # String |  (optional)
integrationGoogleDriveDocumentType = integrationGoogleDriveDocumentType_example # String |  (optional)
integrationType = integrationType_example # String |  (optional)
knowledgeBase = knowledgeBase_example # String |  (optional)
organisation = organisation_example # String |  (optional)
page = page_example # String |  (optional)
permission = permission_example # String | Permission to check for an entity (optional)

try: 
    # list backoffice_autocomplete
    api_response = api_instance.backoffice_autocomplete_list(name, payload, variant=variant, acceptLanguage=acceptLanguage, account=account, bot=bot, botStep=botStep, channel=channel, contact=contact, integration=integration, integrationGoogleDriveDocument=integrationGoogleDriveDocument, integrationGoogleDriveDocumentType=integrationGoogleDriveDocumentType, integrationType=integrationType, knowledgeBase=knowledgeBase, organisation=organisation, page=page, permission=permission)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeAutocompleteApi->backofficeAutocompleteList: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
Autocomplete entity name
Required
Header parameters
Name Description
Accept-Language
String
Account
String
Bot
String
BotStep
String
Channel
String
Contact
String
Integration
String
IntegrationGoogleDriveDocument
String
IntegrationGoogleDriveDocumentType
String
IntegrationType
String
KnowledgeBase
String
Organisation
String
Page
String
Permission
String
Permission to check for an entity
Body parameters
Name Description
payload *
Query parameters
Name Description
variant
String
Autocomplete entity variant

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeAutocompleteList1

list backoffice_autocomplete

List autocomplete items


/0.0.1/backoffice/autocomplete/{name}/{variant}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/autocomplete/{name}/{variant}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeAutocompleteApi;

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

public class BackofficeAutocompleteApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeAutocompleteApi apiInstance = new BackofficeAutocompleteApi();
        String name = name_example; // String | Autocomplete entity name
        String variant = variant_example; // String | Autocomplete entity variant
        AutoCompleteItemCollectionPayload payload = ; // AutoCompleteItemCollectionPayload | Auto complete item collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String account = account_example; // String | 
        String bot = bot_example; // String | 
        String botStep = botStep_example; // String | 
        String channel = channel_example; // String | 
        String contact = contact_example; // String | 
        String integration = integration_example; // String | 
        String integrationGoogleDriveDocument = integrationGoogleDriveDocument_example; // String | 
        String integrationGoogleDriveDocumentType = integrationGoogleDriveDocumentType_example; // String | 
        String integrationType = integrationType_example; // String | 
        String knowledgeBase = knowledgeBase_example; // String | 
        String organisation = organisation_example; // String | 
        String page = page_example; // String | 
        String permission = permission_example; // String | Permission to check for an entity
        try {
            Autocomplete_item_collection result = apiInstance.backofficeAutocompleteList1(name, variant, payload, acceptLanguage, account, bot, botStep, channel, contact, integration, integrationGoogleDriveDocument, integrationGoogleDriveDocumentType, integrationType, knowledgeBase, organisation, page, permission);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAutocompleteApi#backofficeAutocompleteList1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeAutocompleteApi;

public class BackofficeAutocompleteApiExample {

    public static void main(String[] args) {
        BackofficeAutocompleteApi apiInstance = new BackofficeAutocompleteApi();
        String name = name_example; // String | Autocomplete entity name
        String variant = variant_example; // String | Autocomplete entity variant
        AutoCompleteItemCollectionPayload payload = ; // AutoCompleteItemCollectionPayload | Auto complete item collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String account = account_example; // String | 
        String bot = bot_example; // String | 
        String botStep = botStep_example; // String | 
        String channel = channel_example; // String | 
        String contact = contact_example; // String | 
        String integration = integration_example; // String | 
        String integrationGoogleDriveDocument = integrationGoogleDriveDocument_example; // String | 
        String integrationGoogleDriveDocumentType = integrationGoogleDriveDocumentType_example; // String | 
        String integrationType = integrationType_example; // String | 
        String knowledgeBase = knowledgeBase_example; // String | 
        String organisation = organisation_example; // String | 
        String page = page_example; // String | 
        String permission = permission_example; // String | Permission to check for an entity
        try {
            Autocomplete_item_collection result = apiInstance.backofficeAutocompleteList1(name, variant, payload, acceptLanguage, account, bot, botStep, channel, contact, integration, integrationGoogleDriveDocument, integrationGoogleDriveDocumentType, integrationType, knowledgeBase, organisation, page, permission);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeAutocompleteApi#backofficeAutocompleteList1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *name = name_example; // Autocomplete entity name
String *variant = variant_example; // Autocomplete entity variant
AutoCompleteItemCollectionPayload *payload = ; // Auto complete item collection payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *account = account_example; //  (optional)
String *bot = bot_example; //  (optional)
String *botStep = botStep_example; //  (optional)
String *channel = channel_example; //  (optional)
String *contact = contact_example; //  (optional)
String *integration = integration_example; //  (optional)
String *integrationGoogleDriveDocument = integrationGoogleDriveDocument_example; //  (optional)
String *integrationGoogleDriveDocumentType = integrationGoogleDriveDocumentType_example; //  (optional)
String *integrationType = integrationType_example; //  (optional)
String *knowledgeBase = knowledgeBase_example; //  (optional)
String *organisation = organisation_example; //  (optional)
String *page = page_example; //  (optional)
String *permission = permission_example; // Permission to check for an entity (optional)

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

// list backoffice_autocomplete
[apiInstance backofficeAutocompleteList1With:name
    variant:variant
    payload:payload
    acceptLanguage:acceptLanguage
    account:account
    bot:bot
    botStep:botStep
    channel:channel
    contact:contact
    integration:integration
    integrationGoogleDriveDocument:integrationGoogleDriveDocument
    integrationGoogleDriveDocumentType:integrationGoogleDriveDocumentType
    integrationType:integrationType
    knowledgeBase:knowledgeBase
    organisation:organisation
    page:page
    permission:permission
              completionHandler: ^(Autocomplete_item_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeAutocompleteApi()

var name = name_example; // {String} Autocomplete entity name

var variant = variant_example; // {String} Autocomplete entity variant

var payload = ; // {AutoCompleteItemCollectionPayload} Auto complete item collection payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'account': account_example, // {String} 
  'bot': bot_example, // {String} 
  'botStep': botStep_example, // {String} 
  'channel': channel_example, // {String} 
  'contact': contact_example, // {String} 
  'integration': integration_example, // {String} 
  'integrationGoogleDriveDocument': integrationGoogleDriveDocument_example, // {String} 
  'integrationGoogleDriveDocumentType': integrationGoogleDriveDocumentType_example, // {String} 
  'integrationType': integrationType_example, // {String} 
  'knowledgeBase': knowledgeBase_example, // {String} 
  'organisation': organisation_example, // {String} 
  'page': page_example, // {String} 
  'permission': permission_example // {String} Permission to check for an entity
};
api.backofficeAutocompleteList1(name, variant, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeAutocompleteList1Example
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeAutocompleteApi();
            var name = name_example;  // String | Autocomplete entity name
            var variant = variant_example;  // String | Autocomplete entity variant
            var payload = new AutoCompleteItemCollectionPayload(); // AutoCompleteItemCollectionPayload | Auto complete item collection payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var account = account_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var botStep = botStep_example;  // String |  (optional) 
            var channel = channel_example;  // String |  (optional) 
            var contact = contact_example;  // String |  (optional) 
            var integration = integration_example;  // String |  (optional) 
            var integrationGoogleDriveDocument = integrationGoogleDriveDocument_example;  // String |  (optional) 
            var integrationGoogleDriveDocumentType = integrationGoogleDriveDocumentType_example;  // String |  (optional) 
            var integrationType = integrationType_example;  // String |  (optional) 
            var knowledgeBase = knowledgeBase_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 
            var page = page_example;  // String |  (optional) 
            var permission = permission_example;  // String | Permission to check for an entity (optional) 

            try
            {
                // list backoffice_autocomplete
                Autocomplete_item_collection result = apiInstance.backofficeAutocompleteList1(name, variant, payload, acceptLanguage, account, bot, botStep, channel, contact, integration, integrationGoogleDriveDocument, integrationGoogleDriveDocumentType, integrationType, knowledgeBase, organisation, page, permission);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeAutocompleteApi.backofficeAutocompleteList1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeAutocompleteApi();
$name = name_example; // String | Autocomplete entity name
$variant = variant_example; // String | Autocomplete entity variant
$payload = ; // AutoCompleteItemCollectionPayload | Auto complete item collection payload
$acceptLanguage = acceptLanguage_example; // String | 
$account = account_example; // String | 
$bot = bot_example; // String | 
$botStep = botStep_example; // String | 
$channel = channel_example; // String | 
$contact = contact_example; // String | 
$integration = integration_example; // String | 
$integrationGoogleDriveDocument = integrationGoogleDriveDocument_example; // String | 
$integrationGoogleDriveDocumentType = integrationGoogleDriveDocumentType_example; // String | 
$integrationType = integrationType_example; // String | 
$knowledgeBase = knowledgeBase_example; // String | 
$organisation = organisation_example; // String | 
$page = page_example; // String | 
$permission = permission_example; // String | Permission to check for an entity

try {
    $result = $api_instance->backofficeAutocompleteList1($name, $variant, $payload, $acceptLanguage, $account, $bot, $botStep, $channel, $contact, $integration, $integrationGoogleDriveDocument, $integrationGoogleDriveDocumentType, $integrationType, $knowledgeBase, $organisation, $page, $permission);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeAutocompleteApi->backofficeAutocompleteList1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeAutocompleteApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeAutocompleteApi->new();
my $name = name_example; # String | Autocomplete entity name
my $variant = variant_example; # String | Autocomplete entity variant
my $payload = WWW::SwaggerClient::Object::AutoCompleteItemCollectionPayload->new(); # AutoCompleteItemCollectionPayload | Auto complete item collection payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $account = account_example; # String | 
my $bot = bot_example; # String | 
my $botStep = botStep_example; # String | 
my $channel = channel_example; # String | 
my $contact = contact_example; # String | 
my $integration = integration_example; # String | 
my $integrationGoogleDriveDocument = integrationGoogleDriveDocument_example; # String | 
my $integrationGoogleDriveDocumentType = integrationGoogleDriveDocumentType_example; # String | 
my $integrationType = integrationType_example; # String | 
my $knowledgeBase = knowledgeBase_example; # String | 
my $organisation = organisation_example; # String | 
my $page = page_example; # String | 
my $permission = permission_example; # String | Permission to check for an entity

eval { 
    my $result = $api_instance->backofficeAutocompleteList1(name => $name, variant => $variant, payload => $payload, acceptLanguage => $acceptLanguage, account => $account, bot => $bot, botStep => $botStep, channel => $channel, contact => $contact, integration => $integration, integrationGoogleDriveDocument => $integrationGoogleDriveDocument, integrationGoogleDriveDocumentType => $integrationGoogleDriveDocumentType, integrationType => $integrationType, knowledgeBase => $knowledgeBase, organisation => $organisation, page => $page, permission => $permission);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeAutocompleteApi->backofficeAutocompleteList1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeAutocompleteApi()
name = name_example # String | Autocomplete entity name
variant = variant_example # String | Autocomplete entity variant
payload =  # AutoCompleteItemCollectionPayload | Auto complete item collection payload
acceptLanguage = acceptLanguage_example # String |  (optional)
account = account_example # String |  (optional)
bot = bot_example # String |  (optional)
botStep = botStep_example # String |  (optional)
channel = channel_example # String |  (optional)
contact = contact_example # String |  (optional)
integration = integration_example # String |  (optional)
integrationGoogleDriveDocument = integrationGoogleDriveDocument_example # String |  (optional)
integrationGoogleDriveDocumentType = integrationGoogleDriveDocumentType_example # String |  (optional)
integrationType = integrationType_example # String |  (optional)
knowledgeBase = knowledgeBase_example # String |  (optional)
organisation = organisation_example # String |  (optional)
page = page_example # String |  (optional)
permission = permission_example # String | Permission to check for an entity (optional)

try: 
    # list backoffice_autocomplete
    api_response = api_instance.backoffice_autocomplete_list1(name, variant, payload, acceptLanguage=acceptLanguage, account=account, bot=bot, botStep=botStep, channel=channel, contact=contact, integration=integration, integrationGoogleDriveDocument=integrationGoogleDriveDocument, integrationGoogleDriveDocumentType=integrationGoogleDriveDocumentType, integrationType=integrationType, knowledgeBase=knowledgeBase, organisation=organisation, page=page, permission=permission)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeAutocompleteApi->backofficeAutocompleteList1: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
Autocomplete entity name
Required
variant*
String
Autocomplete entity variant
Required
Header parameters
Name Description
Accept-Language
String
Account
String
Bot
String
BotStep
String
Channel
String
Contact
String
Integration
String
IntegrationGoogleDriveDocument
String
IntegrationGoogleDriveDocumentType
String
IntegrationType
String
KnowledgeBase
String
Organisation
String
Page
String
Permission
String
Permission to check for an entity
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


BackofficeBot

backofficeBotConfigureChannel

configure_channel backoffice_bot

Configure bot channel.


/0.0.1/backoffice/bots/{id}/channels/{channelID}/configure

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/{id}/channels/{channelID}/configure"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String channelID = channelID_example; // String | Bot channel ID
        String id = id_example; // String | Bot ID
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Bot_channel_config result = apiInstance.backofficeBotConfigureChannel(channelID, id, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotConfigureChannel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String channelID = channelID_example; // String | Bot channel ID
        String id = id_example; // String | Bot ID
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Bot_channel_config result = apiInstance.backofficeBotConfigureChannel(channelID, id, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotConfigureChannel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *channelID = channelID_example; // Bot channel ID
String *id = id_example; // Bot ID
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)

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

// configure_channel backoffice_bot
[apiInstance backofficeBotConfigureChannelWith:channelID
    id:id
    acceptLanguage:acceptLanguage
    organisation:organisation
              completionHandler: ^(Bot_channel_config output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var channelID = channelID_example; // {String} Bot channel ID

var id = id_example; // {String} Bot ID

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example // {String} 
};
api.backofficeBotConfigureChannel(channelID, id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotConfigureChannelExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var channelID = channelID_example;  // String | Bot channel ID
            var id = id_example;  // String | Bot ID
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // configure_channel backoffice_bot
                Bot_channel_config result = apiInstance.backofficeBotConfigureChannel(channelID, id, acceptLanguage, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotConfigureChannel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$channelID = channelID_example; // String | Bot channel ID
$id = id_example; // String | Bot ID
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeBotConfigureChannel($channelID, $id, $acceptLanguage, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotConfigureChannel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $channelID = channelID_example; # String | Bot channel ID
my $id = id_example; # String | Bot ID
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotConfigureChannel(channelID => $channelID, id => $id, acceptLanguage => $acceptLanguage, organisation => $organisation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotConfigureChannel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
channelID = channelID_example # String | Bot channel ID
id = id_example # String | Bot ID
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)

try: 
    # configure_channel backoffice_bot
    api_response = api_instance.backoffice_bot_configure_channel(channelID, id, acceptLanguage=acceptLanguage, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotConfigureChannel: %s\n" % e)

Parameters

Path parameters
Name Description
channelID*
String
Bot channel ID
Required
id*
String
Bot ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBotCreate

create backoffice_bot

Create new bot


/0.0.1/backoffice/bots

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String organisation = organisation_example; // String | 
        BotCreatePayload payload = ; // BotCreatePayload | Bot create payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot result = apiInstance.backofficeBotCreate(organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotCreate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String organisation = organisation_example; // String | 
        BotCreatePayload payload = ; // BotCreatePayload | Bot create payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot result = apiInstance.backofficeBotCreate(organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
BotCreatePayload *payload = ; // Bot create payload
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// create backoffice_bot
[apiInstance backofficeBotCreateWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var organisation = organisation_example; // {String} 

var payload = ; // {BotCreatePayload} Bot create payload

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotCreate(organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotCreateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var organisation = organisation_example;  // String | 
            var payload = new BotCreatePayload(); // BotCreatePayload | Bot create payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // create backoffice_bot
                Bot result = apiInstance.backofficeBotCreate(organisation, payload, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$organisation = organisation_example; // String | 
$payload = ; // BotCreatePayload | Bot create payload
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotCreate($organisation, $payload, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::BotCreatePayload->new(); # BotCreatePayload | Bot create payload
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotCreate(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotCreate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
organisation = organisation_example # String | 
payload =  # BotCreatePayload | Bot create payload
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # create backoffice_bot
    api_response = api_instance.backoffice_bot_create(organisation, payload, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotCreate: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeBotCreateBatchUpdate

create_batch_update backoffice_bot

Create bot batch update.


/0.0.1/backoffice/bots/batch_updates

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/batch_updates"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String organisation = organisation_example; // String | 
        BotBatchUpdatePayload payload = ; // BotBatchUpdatePayload | Bot batch update payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_batch_update result = apiInstance.backofficeBotCreateBatchUpdate(organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotCreateBatchUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String organisation = organisation_example; // String | 
        BotBatchUpdatePayload payload = ; // BotBatchUpdatePayload | Bot batch update payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_batch_update result = apiInstance.backofficeBotCreateBatchUpdate(organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotCreateBatchUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
BotBatchUpdatePayload *payload = ; // Bot batch update payload
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// create_batch_update backoffice_bot
[apiInstance backofficeBotCreateBatchUpdateWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot_batch_update output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var organisation = organisation_example; // {String} 

var payload = ; // {BotBatchUpdatePayload} Bot batch update payload

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotCreateBatchUpdate(organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotCreateBatchUpdateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var organisation = organisation_example;  // String | 
            var payload = new BotBatchUpdatePayload(); // BotBatchUpdatePayload | Bot batch update payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // create_batch_update backoffice_bot
                Bot_batch_update result = apiInstance.backofficeBotCreateBatchUpdate(organisation, payload, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotCreateBatchUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$organisation = organisation_example; // String | 
$payload = ; // BotBatchUpdatePayload | Bot batch update payload
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotCreateBatchUpdate($organisation, $payload, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotCreateBatchUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::BotBatchUpdatePayload->new(); # BotBatchUpdatePayload | Bot batch update payload
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotCreateBatchUpdate(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotCreateBatchUpdate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
organisation = organisation_example # String | 
payload =  # BotBatchUpdatePayload | Bot batch update payload
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # create_batch_update backoffice_bot
    api_response = api_instance.backoffice_bot_create_batch_update(organisation, payload, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotCreateBatchUpdate: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBotCreateChannel

create_channel backoffice_bot

Create bot channel.


/0.0.1/backoffice/bots/{id}/channels

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/{id}/channels"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        BotChannelPayload payload = ; // BotChannelPayload | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_channel result = apiInstance.backofficeBotCreateChannel(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotCreateChannel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        BotChannelPayload payload = ; // BotChannelPayload | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_channel result = apiInstance.backofficeBotCreateChannel(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotCreateChannel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Bot ID
String *organisation = organisation_example; // 
BotChannelPayload *payload = ; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// create_channel backoffice_bot
[apiInstance backofficeBotCreateChannelWith:id
    organisation:organisation
    payload:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot_channel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var id = id_example; // {String} Bot ID

var organisation = organisation_example; // {String} 

var payload = ; // {BotChannelPayload} 

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotCreateChannel(id, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotCreateChannelExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var id = id_example;  // String | Bot ID
            var organisation = organisation_example;  // String | 
            var payload = new BotChannelPayload(); // BotChannelPayload | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // create_channel backoffice_bot
                Bot_channel result = apiInstance.backofficeBotCreateChannel(id, organisation, payload, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotCreateChannel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$id = id_example; // String | Bot ID
$organisation = organisation_example; // String | 
$payload = ; // BotChannelPayload | 
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotCreateChannel($id, $organisation, $payload, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotCreateChannel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $id = id_example; # String | Bot ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::BotChannelPayload->new(); # BotChannelPayload | 
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotCreateChannel(id => $id, organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotCreateChannel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
id = id_example # String | Bot ID
organisation = organisation_example # String | 
payload =  # BotChannelPayload | 
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # create_channel backoffice_bot
    api_response = api_instance.backoffice_bot_create_channel(id, organisation, payload, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotCreateChannel: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeBotDelete

delete backoffice_bot


/0.0.1/backoffice/bots/{id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            apiInstance.backofficeBotDelete(id, organisation, acceptLanguage);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            apiInstance.backofficeBotDelete(id, organisation, acceptLanguage);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Bot ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// delete backoffice_bot
[apiInstance backofficeBotDeleteWith:id
    organisation:organisation
    acceptLanguage:acceptLanguage
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var id = id_example; // {String} Bot ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotDelete(id, organisation, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotDeleteExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var id = id_example;  // String | Bot ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // delete backoffice_bot
                apiInstance.backofficeBotDelete(id, organisation, acceptLanguage);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$id = id_example; // String | Bot ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $api_instance->backofficeBotDelete($id, $organisation, $acceptLanguage);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $id = id_example; # String | Bot ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    $api_instance->backofficeBotDelete(id => $id, organisation => $organisation, acceptLanguage => $acceptLanguage);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
id = id_example # String | Bot ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # delete backoffice_bot
    api_instance.backoffice_bot_delete(id, organisation, acceptLanguage=acceptLanguage)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotDelete: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBotDeleteBatchUpdate

delete_batch_update backoffice_bot


/0.0.1/backoffice/bots/batch_updates

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/batch_updates"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String organisation = organisation_example; // String | 
        BotBatchUpdateCollectionPayload payload = ; // BotBatchUpdateCollectionPayload | Bot batch update collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            apiInstance.backofficeBotDeleteBatchUpdate(organisation, payload, acceptLanguage);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotDeleteBatchUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String organisation = organisation_example; // String | 
        BotBatchUpdateCollectionPayload payload = ; // BotBatchUpdateCollectionPayload | Bot batch update collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            apiInstance.backofficeBotDeleteBatchUpdate(organisation, payload, acceptLanguage);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotDeleteBatchUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
BotBatchUpdateCollectionPayload *payload = ; // Bot batch update collection payload
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// delete_batch_update backoffice_bot
[apiInstance backofficeBotDeleteBatchUpdateWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var organisation = organisation_example; // {String} 

var payload = ; // {BotBatchUpdateCollectionPayload} Bot batch update collection payload

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotDeleteBatchUpdate(organisation, payload, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotDeleteBatchUpdateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var organisation = organisation_example;  // String | 
            var payload = new BotBatchUpdateCollectionPayload(); // BotBatchUpdateCollectionPayload | Bot batch update collection payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // delete_batch_update backoffice_bot
                apiInstance.backofficeBotDeleteBatchUpdate(organisation, payload, acceptLanguage);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotDeleteBatchUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$organisation = organisation_example; // String | 
$payload = ; // BotBatchUpdateCollectionPayload | Bot batch update collection payload
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $api_instance->backofficeBotDeleteBatchUpdate($organisation, $payload, $acceptLanguage);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotDeleteBatchUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::BotBatchUpdateCollectionPayload->new(); # BotBatchUpdateCollectionPayload | Bot batch update collection payload
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    $api_instance->backofficeBotDeleteBatchUpdate(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotDeleteBatchUpdate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
organisation = organisation_example # String | 
payload =  # BotBatchUpdateCollectionPayload | Bot batch update collection payload
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # delete_batch_update backoffice_bot
    api_instance.backoffice_bot_delete_batch_update(organisation, payload, acceptLanguage=acceptLanguage)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotDeleteBatchUpdate: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBotDeleteChannel

delete_channel backoffice_bot

Delete bot channel.


/0.0.1/backoffice/bots/{id}/channels/{channelID}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/{id}/channels/{channelID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String channelID = channelID_example; // String | Bot channel ID
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            apiInstance.backofficeBotDeleteChannel(channelID, id, organisation, acceptLanguage);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotDeleteChannel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String channelID = channelID_example; // String | Bot channel ID
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            apiInstance.backofficeBotDeleteChannel(channelID, id, organisation, acceptLanguage);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotDeleteChannel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *channelID = channelID_example; // Bot channel ID
String *id = id_example; // Bot ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// delete_channel backoffice_bot
[apiInstance backofficeBotDeleteChannelWith:channelID
    id:id
    organisation:organisation
    acceptLanguage:acceptLanguage
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var channelID = channelID_example; // {String} Bot channel ID

var id = id_example; // {String} Bot ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotDeleteChannel(channelID, id, organisation, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotDeleteChannelExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var channelID = channelID_example;  // String | Bot channel ID
            var id = id_example;  // String | Bot ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // delete_channel backoffice_bot
                apiInstance.backofficeBotDeleteChannel(channelID, id, organisation, acceptLanguage);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotDeleteChannel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$channelID = channelID_example; // String | Bot channel ID
$id = id_example; // String | Bot ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $api_instance->backofficeBotDeleteChannel($channelID, $id, $organisation, $acceptLanguage);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotDeleteChannel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $channelID = channelID_example; # String | Bot channel ID
my $id = id_example; # String | Bot ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    $api_instance->backofficeBotDeleteChannel(channelID => $channelID, id => $id, organisation => $organisation, acceptLanguage => $acceptLanguage);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotDeleteChannel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
channelID = channelID_example # String | Bot channel ID
id = id_example # String | Bot ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # delete_channel backoffice_bot
    api_instance.backoffice_bot_delete_channel(channelID, id, organisation, acceptLanguage=acceptLanguage)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotDeleteChannel: %s\n" % e)

Parameters

Path parameters
Name Description
channelID*
String
Bot channel ID
Required
id*
String
Bot ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBotDeleteReportingToken

delete_reporting_token backoffice_bot


/0.0.1/backoffice/bots/{id}/reporting_token

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/{id}/reporting_token"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            BotReporting result = apiInstance.backofficeBotDeleteReportingToken(id, organisation, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotDeleteReportingToken");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            BotReporting result = apiInstance.backofficeBotDeleteReportingToken(id, organisation, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotDeleteReportingToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Bot ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// delete_reporting_token backoffice_bot
[apiInstance backofficeBotDeleteReportingTokenWith:id
    organisation:organisation
    acceptLanguage:acceptLanguage
              completionHandler: ^(BotReporting output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var id = id_example; // {String} Bot ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotDeleteReportingToken(id, organisation, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotDeleteReportingTokenExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var id = id_example;  // String | Bot ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // delete_reporting_token backoffice_bot
                BotReporting result = apiInstance.backofficeBotDeleteReportingToken(id, organisation, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotDeleteReportingToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$id = id_example; // String | Bot ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotDeleteReportingToken($id, $organisation, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotDeleteReportingToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $id = id_example; # String | Bot ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
id = id_example # String | Bot ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # delete_reporting_token backoffice_bot
    api_response = api_instance.backoffice_bot_delete_reporting_token(id, organisation, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotDeleteReportingToken: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBotDeleteResponses

delete_responses backoffice_bot

Delete bot responses.


/0.0.1/backoffice/bots/responses

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/responses"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String organisation = organisation_example; // String | 
        BotResponseDeletePayload payload = ; // BotResponseDeletePayload | Bot response delete payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            apiInstance.backofficeBotDeleteResponses(organisation, payload, acceptLanguage);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotDeleteResponses");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String organisation = organisation_example; // String | 
        BotResponseDeletePayload payload = ; // BotResponseDeletePayload | Bot response delete payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            apiInstance.backofficeBotDeleteResponses(organisation, payload, acceptLanguage);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotDeleteResponses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
BotResponseDeletePayload *payload = ; // Bot response delete payload
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// delete_responses backoffice_bot
[apiInstance backofficeBotDeleteResponsesWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var organisation = organisation_example; // {String} 

var payload = ; // {BotResponseDeletePayload} Bot response delete payload

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotDeleteResponses(organisation, payload, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotDeleteResponsesExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var organisation = organisation_example;  // String | 
            var payload = new BotResponseDeletePayload(); // BotResponseDeletePayload | Bot response delete payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // delete_responses backoffice_bot
                apiInstance.backofficeBotDeleteResponses(organisation, payload, acceptLanguage);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotDeleteResponses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$organisation = organisation_example; // String | 
$payload = ; // BotResponseDeletePayload | Bot response delete payload
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $api_instance->backofficeBotDeleteResponses($organisation, $payload, $acceptLanguage);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotDeleteResponses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::BotResponseDeletePayload->new(); # BotResponseDeletePayload | Bot response delete payload
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    $api_instance->backofficeBotDeleteResponses(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotDeleteResponses: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
organisation = organisation_example # String | 
payload =  # BotResponseDeletePayload | Bot response delete payload
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # delete_responses backoffice_bot
    api_instance.backoffice_bot_delete_responses(organisation, payload, acceptLanguage=acceptLanguage)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotDeleteResponses: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeBotDownloadList

download_list backoffice_bot

Download bot list.


/0.0.1/backoffice/bots/list/download

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/list/download"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String organisation = organisation_example; // String | 
        BotCollectionPayload payload = ; // BotCollectionPayload | Bot collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Download result = apiInstance.backofficeBotDownloadList(organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotDownloadList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String organisation = organisation_example; // String | 
        BotCollectionPayload payload = ; // BotCollectionPayload | Bot collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Download result = apiInstance.backofficeBotDownloadList(organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotDownloadList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
BotCollectionPayload *payload = ; // Bot collection payload
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// download_list backoffice_bot
[apiInstance backofficeBotDownloadListWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(Download output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var organisation = organisation_example; // {String} 

var payload = ; // {BotCollectionPayload} Bot collection payload

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotDownloadList(organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotDownloadListExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var organisation = organisation_example;  // String | 
            var payload = new BotCollectionPayload(); // BotCollectionPayload | Bot collection payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // download_list backoffice_bot
                Download result = apiInstance.backofficeBotDownloadList(organisation, payload, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotDownloadList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$organisation = organisation_example; // String | 
$payload = ; // BotCollectionPayload | Bot collection payload
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotDownloadList($organisation, $payload, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotDownloadList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::BotCollectionPayload->new(); # BotCollectionPayload | Bot collection payload
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotDownloadList(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotDownloadList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
organisation = organisation_example # String | 
payload =  # BotCollectionPayload | Bot collection payload
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # download_list backoffice_bot
    api_response = api_instance.backoffice_bot_download_list(organisation, payload, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotDownloadList: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 429 - Too many requests


backofficeBotDownloadResponses

download_responses backoffice_bot

Retrieve bot responses.


/0.0.1/backoffice/bots/responses/download

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/responses/download"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String organisation = organisation_example; // String | 
        BotResponseCollectionPayload payload = ; // BotResponseCollectionPayload | Bot response collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Download result = apiInstance.backofficeBotDownloadResponses(organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotDownloadResponses");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String organisation = organisation_example; // String | 
        BotResponseCollectionPayload payload = ; // BotResponseCollectionPayload | Bot response collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Download result = apiInstance.backofficeBotDownloadResponses(organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotDownloadResponses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
BotResponseCollectionPayload *payload = ; // Bot response collection payload
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// download_responses backoffice_bot
[apiInstance backofficeBotDownloadResponsesWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(Download output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var organisation = organisation_example; // {String} 

var payload = ; // {BotResponseCollectionPayload} Bot response collection payload

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotDownloadResponses(organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotDownloadResponsesExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var organisation = organisation_example;  // String | 
            var payload = new BotResponseCollectionPayload(); // BotResponseCollectionPayload | Bot response collection payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // download_responses backoffice_bot
                Download result = apiInstance.backofficeBotDownloadResponses(organisation, payload, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotDownloadResponses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$organisation = organisation_example; // String | 
$payload = ; // BotResponseCollectionPayload | Bot response collection payload
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotDownloadResponses($organisation, $payload, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotDownloadResponses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::BotResponseCollectionPayload->new(); # BotResponseCollectionPayload | Bot response collection payload
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotDownloadResponses(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotDownloadResponses: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
organisation = organisation_example # String | 
payload =  # BotResponseCollectionPayload | Bot response collection payload
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # download_responses backoffice_bot
    api_response = api_instance.backoffice_bot_download_responses(organisation, payload, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotDownloadResponses: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeBotExport

export backoffice_bot

Export the bot with given id.


/0.0.1/backoffice/bots/{id}/export/{format}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/{id}/export/{format}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String format = format_example; // String | Format
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Download result = apiInstance.backofficeBotExport(format, id, organisation, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotExport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String format = format_example; // String | Format
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Download result = apiInstance.backofficeBotExport(format, id, organisation, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotExport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *format = format_example; // Format
String *id = id_example; // Bot ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// export backoffice_bot
[apiInstance backofficeBotExportWith:format
    id:id
    organisation:organisation
    acceptLanguage:acceptLanguage
              completionHandler: ^(Download output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var format = format_example; // {String} Format

var id = id_example; // {String} Bot ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotExport(format, id, organisation, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotExportExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var format = format_example;  // String | Format
            var id = id_example;  // String | Bot ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // export backoffice_bot
                Download result = apiInstance.backofficeBotExport(format, id, organisation, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotExport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$format = format_example; // String | Format
$id = id_example; // String | Bot ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotExport($format, $id, $organisation, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotExport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $format = format_example; # String | Format
my $id = id_example; # String | Bot ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotExport(format => $format, id => $id, organisation => $organisation, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotExport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
format = format_example # String | Format
id = id_example # String | Bot ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # export backoffice_bot
    api_response = api_instance.backoffice_bot_export(format, id, organisation, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotExport: %s\n" % e)

Parameters

Path parameters
Name Description
format*
String
Format
Required
id*
String
Bot ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBotGenerateReportingToken

generate_reporting_token backoffice_bot


/0.0.1/backoffice/bots/{id}/reporting_token

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/{id}/reporting_token"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        BotReportingTokenPayload payload = ; // BotReportingTokenPayload | Bot reporting token payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            BotReporting result = apiInstance.backofficeBotGenerateReportingToken(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotGenerateReportingToken");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        BotReportingTokenPayload payload = ; // BotReportingTokenPayload | Bot reporting token payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            BotReporting result = apiInstance.backofficeBotGenerateReportingToken(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotGenerateReportingToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Bot ID
String *organisation = organisation_example; // 
BotReportingTokenPayload *payload = ; // Bot reporting token payload
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// generate_reporting_token backoffice_bot
[apiInstance backofficeBotGenerateReportingTokenWith:id
    organisation:organisation
    payload:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(BotReporting output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var id = id_example; // {String} Bot ID

var organisation = organisation_example; // {String} 

var payload = ; // {BotReportingTokenPayload} Bot reporting token payload

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotGenerateReportingToken(id, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotGenerateReportingTokenExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var id = id_example;  // String | Bot ID
            var organisation = organisation_example;  // String | 
            var payload = new BotReportingTokenPayload(); // BotReportingTokenPayload | Bot reporting token payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // generate_reporting_token backoffice_bot
                BotReporting result = apiInstance.backofficeBotGenerateReportingToken(id, organisation, payload, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotGenerateReportingToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$id = id_example; // String | Bot ID
$organisation = organisation_example; // String | 
$payload = ; // BotReportingTokenPayload | Bot reporting token payload
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotGenerateReportingToken($id, $organisation, $payload, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotGenerateReportingToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $id = id_example; # String | Bot ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::BotReportingTokenPayload->new(); # BotReportingTokenPayload | Bot reporting token payload
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotGenerateReportingToken(id => $id, organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotGenerateReportingToken: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
id = id_example # String | Bot ID
organisation = organisation_example # String | 
payload =  # BotReportingTokenPayload | Bot reporting token payload
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # generate_reporting_token backoffice_bot
    api_response = api_instance.backoffice_bot_generate_reporting_token(id, organisation, payload, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotGenerateReportingToken: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBotGetReportingToken

get_reporting_token backoffice_bot


/0.0.1/backoffice/bots/{id}/reporting_token/get

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/{id}/reporting_token/get"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        BotReportingTokenPayload payload = ; // BotReportingTokenPayload | Bot reporting token payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            BotReporting result = apiInstance.backofficeBotGetReportingToken(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotGetReportingToken");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        BotReportingTokenPayload payload = ; // BotReportingTokenPayload | Bot reporting token payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            BotReporting result = apiInstance.backofficeBotGetReportingToken(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotGetReportingToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Bot ID
String *organisation = organisation_example; // 
BotReportingTokenPayload *payload = ; // Bot reporting token payload
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// get_reporting_token backoffice_bot
[apiInstance backofficeBotGetReportingTokenWith:id
    organisation:organisation
    payload:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(BotReporting output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var id = id_example; // {String} Bot ID

var organisation = organisation_example; // {String} 

var payload = ; // {BotReportingTokenPayload} Bot reporting token payload

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotGetReportingToken(id, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotGetReportingTokenExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var id = id_example;  // String | Bot ID
            var organisation = organisation_example;  // String | 
            var payload = new BotReportingTokenPayload(); // BotReportingTokenPayload | Bot reporting token payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // get_reporting_token backoffice_bot
                BotReporting result = apiInstance.backofficeBotGetReportingToken(id, organisation, payload, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotGetReportingToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$id = id_example; // String | Bot ID
$organisation = organisation_example; // String | 
$payload = ; // BotReportingTokenPayload | Bot reporting token payload
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotGetReportingToken($id, $organisation, $payload, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotGetReportingToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $id = id_example; # String | Bot ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::BotReportingTokenPayload->new(); # BotReportingTokenPayload | Bot reporting token payload
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotGetReportingToken(id => $id, organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotGetReportingToken: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
id = id_example # String | Bot ID
organisation = organisation_example # String | 
payload =  # BotReportingTokenPayload | Bot reporting token payload
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # get_reporting_token backoffice_bot
    api_response = api_instance.backoffice_bot_get_reporting_token(id, organisation, payload, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotGetReportingToken: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBotLaunchChannel

launch_channel backoffice_bot

Launch bot channel.


/0.0.1/backoffice/bots/{id}/channels/{channelID}/launch

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/{id}/channels/{channelID}/launch"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String channelID = channelID_example; // String | Bot channel ID
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_channel result = apiInstance.backofficeBotLaunchChannel(channelID, id, organisation, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotLaunchChannel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String channelID = channelID_example; // String | Bot channel ID
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_channel result = apiInstance.backofficeBotLaunchChannel(channelID, id, organisation, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotLaunchChannel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *channelID = channelID_example; // Bot channel ID
String *id = id_example; // Bot ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// launch_channel backoffice_bot
[apiInstance backofficeBotLaunchChannelWith:channelID
    id:id
    organisation:organisation
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot_channel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var channelID = channelID_example; // {String} Bot channel ID

var id = id_example; // {String} Bot ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotLaunchChannel(channelID, id, organisation, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotLaunchChannelExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var channelID = channelID_example;  // String | Bot channel ID
            var id = id_example;  // String | Bot ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // launch_channel backoffice_bot
                Bot_channel result = apiInstance.backofficeBotLaunchChannel(channelID, id, organisation, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotLaunchChannel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$channelID = channelID_example; // String | Bot channel ID
$id = id_example; // String | Bot ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotLaunchChannel($channelID, $id, $organisation, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotLaunchChannel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $channelID = channelID_example; # String | Bot channel ID
my $id = id_example; # String | Bot ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotLaunchChannel(channelID => $channelID, id => $id, organisation => $organisation, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotLaunchChannel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
channelID = channelID_example # String | Bot channel ID
id = id_example # String | Bot ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # launch_channel backoffice_bot
    api_response = api_instance.backoffice_bot_launch_channel(channelID, id, organisation, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotLaunchChannel: %s\n" % e)

Parameters

Path parameters
Name Description
channelID*
String
Bot channel ID
Required
id*
String
Bot ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBotList

list backoffice_bot

Retrieve all questionnaires.


/0.0.1/backoffice/bots/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String organisation = organisation_example; // String | 
        BotCollectionPayload payload = ; // BotCollectionPayload | Bot collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_collection result = apiInstance.backofficeBotList(organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String organisation = organisation_example; // String | 
        BotCollectionPayload payload = ; // BotCollectionPayload | Bot collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_collection result = apiInstance.backofficeBotList(organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
BotCollectionPayload *payload = ; // Bot collection payload
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// list backoffice_bot
[apiInstance backofficeBotListWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var organisation = organisation_example; // {String} 

var payload = ; // {BotCollectionPayload} Bot collection payload

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotList(organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotListExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var organisation = organisation_example;  // String | 
            var payload = new BotCollectionPayload(); // BotCollectionPayload | Bot collection payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // list backoffice_bot
                Bot_collection result = apiInstance.backofficeBotList(organisation, payload, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$organisation = organisation_example; // String | 
$payload = ; // BotCollectionPayload | Bot collection payload
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotList($organisation, $payload, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::BotCollectionPayload->new(); # BotCollectionPayload | Bot collection payload
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotList(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
organisation = organisation_example # String | 
payload =  # BotCollectionPayload | Bot collection payload
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # list backoffice_bot
    api_response = api_instance.backoffice_bot_list(organisation, payload, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotList: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeBotListBatchUpdate

list_batch_update backoffice_bot

Retrieve bot batch updates.


/0.0.1/backoffice/bots/batch_updates/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/batch_updates/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String organisation = organisation_example; // String | 
        BotBatchUpdateCollectionPayload payload = ; // BotBatchUpdateCollectionPayload | Bot batch update collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_batch_update_collection result = apiInstance.backofficeBotListBatchUpdate(organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotListBatchUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String organisation = organisation_example; // String | 
        BotBatchUpdateCollectionPayload payload = ; // BotBatchUpdateCollectionPayload | Bot batch update collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_batch_update_collection result = apiInstance.backofficeBotListBatchUpdate(organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotListBatchUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
BotBatchUpdateCollectionPayload *payload = ; // Bot batch update collection payload
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// list_batch_update backoffice_bot
[apiInstance backofficeBotListBatchUpdateWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot_batch_update_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var organisation = organisation_example; // {String} 

var payload = ; // {BotBatchUpdateCollectionPayload} Bot batch update collection payload

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotListBatchUpdate(organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotListBatchUpdateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var organisation = organisation_example;  // String | 
            var payload = new BotBatchUpdateCollectionPayload(); // BotBatchUpdateCollectionPayload | Bot batch update collection payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // list_batch_update backoffice_bot
                Bot_batch_update_collection result = apiInstance.backofficeBotListBatchUpdate(organisation, payload, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotListBatchUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$organisation = organisation_example; // String | 
$payload = ; // BotBatchUpdateCollectionPayload | Bot batch update collection payload
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotListBatchUpdate($organisation, $payload, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotListBatchUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::BotBatchUpdateCollectionPayload->new(); # BotBatchUpdateCollectionPayload | Bot batch update collection payload
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotListBatchUpdate(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotListBatchUpdate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
organisation = organisation_example # String | 
payload =  # BotBatchUpdateCollectionPayload | Bot batch update collection payload
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # list_batch_update backoffice_bot
    api_response = api_instance.backoffice_bot_list_batch_update(organisation, payload, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotListBatchUpdate: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeBotListChannel

list_channel backoffice_bot

Retrieve bot channels.


/0.0.1/backoffice/bots/{id}/channels/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/{id}/channels/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        BotChannelCollectionPayload payload = ; // BotChannelCollectionPayload | Bot channel collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_channel_collection result = apiInstance.backofficeBotListChannel(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotListChannel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        BotChannelCollectionPayload payload = ; // BotChannelCollectionPayload | Bot channel collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_channel_collection result = apiInstance.backofficeBotListChannel(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotListChannel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Bot ID
String *organisation = organisation_example; // 
BotChannelCollectionPayload *payload = ; // Bot channel collection payload
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// list_channel backoffice_bot
[apiInstance backofficeBotListChannelWith:id
    organisation:organisation
    payload:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot_channel_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var id = id_example; // {String} Bot ID

var organisation = organisation_example; // {String} 

var payload = ; // {BotChannelCollectionPayload} Bot channel collection payload

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotListChannel(id, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotListChannelExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var id = id_example;  // String | Bot ID
            var organisation = organisation_example;  // String | 
            var payload = new BotChannelCollectionPayload(); // BotChannelCollectionPayload | Bot channel collection payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // list_channel backoffice_bot
                Bot_channel_collection result = apiInstance.backofficeBotListChannel(id, organisation, payload, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotListChannel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$id = id_example; // String | Bot ID
$organisation = organisation_example; // String | 
$payload = ; // BotChannelCollectionPayload | Bot channel collection payload
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotListChannel($id, $organisation, $payload, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotListChannel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $id = id_example; # String | Bot ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::BotChannelCollectionPayload->new(); # BotChannelCollectionPayload | Bot channel collection payload
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotListChannel(id => $id, organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotListChannel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
id = id_example # String | Bot ID
organisation = organisation_example # String | 
payload =  # BotChannelCollectionPayload | Bot channel collection payload
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # list_channel backoffice_bot
    api_response = api_instance.backoffice_bot_list_channel(id, organisation, payload, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotListChannel: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeBotPrepareBatchUpdate

prepare_batch_update backoffice_bot

Prepare bot batch update.


/0.0.1/backoffice/bots/batch_updates/{id}/prepare

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/batch_updates/{id}/prepare"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot batch update ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_batch_update result = apiInstance.backofficeBotPrepareBatchUpdate(id, organisation, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotPrepareBatchUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot batch update ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_batch_update result = apiInstance.backofficeBotPrepareBatchUpdate(id, organisation, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotPrepareBatchUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Bot batch update ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// prepare_batch_update backoffice_bot
[apiInstance backofficeBotPrepareBatchUpdateWith:id
    organisation:organisation
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot_batch_update output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var id = id_example; // {String} Bot batch update ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotPrepareBatchUpdate(id, organisation, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotPrepareBatchUpdateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var id = id_example;  // String | Bot batch update ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // prepare_batch_update backoffice_bot
                Bot_batch_update result = apiInstance.backofficeBotPrepareBatchUpdate(id, organisation, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotPrepareBatchUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$id = id_example; // String | Bot batch update ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotPrepareBatchUpdate($id, $organisation, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotPrepareBatchUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $id = id_example; # String | Bot batch update ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
id = id_example # String | Bot batch update ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # prepare_batch_update backoffice_bot
    api_response = api_instance.backoffice_bot_prepare_batch_update(id, organisation, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotPrepareBatchUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot batch update ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBotPreview

preview backoffice_bot

Bot preview.


/0.0.1/backoffice/bots/preview

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/preview"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String organisation = organisation_example; // String | 
        BotPreviewPayload payload = ; // BotPreviewPayload | Bot preview payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            BotPreview result = apiInstance.backofficeBotPreview(organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotPreview");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String organisation = organisation_example; // String | 
        BotPreviewPayload payload = ; // BotPreviewPayload | Bot preview payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            BotPreview result = apiInstance.backofficeBotPreview(organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotPreview");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
BotPreviewPayload *payload = ; // Bot preview payload
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// preview backoffice_bot
[apiInstance backofficeBotPreviewWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(BotPreview output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var organisation = organisation_example; // {String} 

var payload = ; // {BotPreviewPayload} Bot preview payload

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotPreview(organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotPreviewExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var organisation = organisation_example;  // String | 
            var payload = new BotPreviewPayload(); // BotPreviewPayload | Bot preview payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // preview backoffice_bot
                BotPreview result = apiInstance.backofficeBotPreview(organisation, payload, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotPreview: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$organisation = organisation_example; // String | 
$payload = ; // BotPreviewPayload | Bot preview payload
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotPreview($organisation, $payload, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotPreview: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::BotPreviewPayload->new(); # BotPreviewPayload | Bot preview payload
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotPreview(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotPreview: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
organisation = organisation_example # String | 
payload =  # BotPreviewPayload | Bot preview payload
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # preview backoffice_bot
    api_response = api_instance.backoffice_bot_preview(organisation, payload, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotPreview: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeBotPreviewChannel

preview_channel backoffice_bot

Preview bot channel.


/0.0.1/backoffice/bots/{id}/channels/{channelID}/preview

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/{id}/channels/{channelID}/preview"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String channelID = channelID_example; // String | Bot channel ID
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_channel_preview result = apiInstance.backofficeBotPreviewChannel(channelID, id, organisation, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotPreviewChannel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String channelID = channelID_example; // String | Bot channel ID
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_channel_preview result = apiInstance.backofficeBotPreviewChannel(channelID, id, organisation, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotPreviewChannel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *channelID = channelID_example; // Bot channel ID
String *id = id_example; // Bot ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// preview_channel backoffice_bot
[apiInstance backofficeBotPreviewChannelWith:channelID
    id:id
    organisation:organisation
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot_channel_preview output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var channelID = channelID_example; // {String} Bot channel ID

var id = id_example; // {String} Bot ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotPreviewChannel(channelID, id, organisation, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotPreviewChannelExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var channelID = channelID_example;  // String | Bot channel ID
            var id = id_example;  // String | Bot ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // preview_channel backoffice_bot
                Bot_channel_preview result = apiInstance.backofficeBotPreviewChannel(channelID, id, organisation, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotPreviewChannel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$channelID = channelID_example; // String | Bot channel ID
$id = id_example; // String | Bot ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotPreviewChannel($channelID, $id, $organisation, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotPreviewChannel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $channelID = channelID_example; # String | Bot channel ID
my $id = id_example; # String | Bot ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotPreviewChannel(channelID => $channelID, id => $id, organisation => $organisation, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotPreviewChannel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
channelID = channelID_example # String | Bot channel ID
id = id_example # String | Bot ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # preview_channel backoffice_bot
    api_response = api_instance.backoffice_bot_preview_channel(channelID, id, organisation, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotPreviewChannel: %s\n" % e)

Parameters

Path parameters
Name Description
channelID*
String
Bot channel ID
Required
id*
String
Bot ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBotProcessBatchUpdate

process_batch_update backoffice_bot

Process bot batch update.


/0.0.1/backoffice/bots/batch_updates/{id}/process

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/batch_updates/{id}/process"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot batch update ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            apiInstance.backofficeBotProcessBatchUpdate(id, organisation, acceptLanguage);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotProcessBatchUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot batch update ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            apiInstance.backofficeBotProcessBatchUpdate(id, organisation, acceptLanguage);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotProcessBatchUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Bot batch update ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// process_batch_update backoffice_bot
[apiInstance backofficeBotProcessBatchUpdateWith:id
    organisation:organisation
    acceptLanguage:acceptLanguage
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var id = id_example; // {String} Bot batch update ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotProcessBatchUpdate(id, organisation, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotProcessBatchUpdateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var id = id_example;  // String | Bot batch update ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // process_batch_update backoffice_bot
                apiInstance.backofficeBotProcessBatchUpdate(id, organisation, acceptLanguage);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotProcessBatchUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$id = id_example; // String | Bot batch update ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $api_instance->backofficeBotProcessBatchUpdate($id, $organisation, $acceptLanguage);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotProcessBatchUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $id = id_example; # String | Bot batch update ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    $api_instance->backofficeBotProcessBatchUpdate(id => $id, organisation => $organisation, acceptLanguage => $acceptLanguage);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotProcessBatchUpdate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
id = id_example # String | Bot batch update ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # process_batch_update backoffice_bot
    api_instance.backoffice_bot_process_batch_update(id, organisation, acceptLanguage=acceptLanguage)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotProcessBatchUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot batch update ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBotReindex

reindex backoffice_bot


/0.0.1/backoffice/bots/{id}/reindex

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/{id}/reindex"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            apiInstance.backofficeBotReindex(id, organisation, acceptLanguage);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotReindex");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            apiInstance.backofficeBotReindex(id, organisation, acceptLanguage);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotReindex");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Bot ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// reindex backoffice_bot
[apiInstance backofficeBotReindexWith:id
    organisation:organisation
    acceptLanguage:acceptLanguage
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var id = id_example; // {String} Bot ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotReindex(id, organisation, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotReindexExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var id = id_example;  // String | Bot ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // reindex backoffice_bot
                apiInstance.backofficeBotReindex(id, organisation, acceptLanguage);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotReindex: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$id = id_example; // String | Bot ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $api_instance->backofficeBotReindex($id, $organisation, $acceptLanguage);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotReindex: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $id = id_example; # String | Bot ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    $api_instance->backofficeBotReindex(id => $id, organisation => $organisation, acceptLanguage => $acceptLanguage);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotReindex: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
id = id_example # String | Bot ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # reindex backoffice_bot
    api_instance.backoffice_bot_reindex(id, organisation, acceptLanguage=acceptLanguage)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotReindex: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBotShow

show backoffice_bot

Retrieve questionnaire with given id.


/0.0.1/backoffice/bots/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot result = apiInstance.backofficeBotShow(id, organisation, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot result = apiInstance.backofficeBotShow(id, organisation, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Bot ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// show backoffice_bot
[apiInstance backofficeBotShowWith:id
    organisation:organisation
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var id = id_example; // {String} Bot ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotShow(id, organisation, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotShowExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var id = id_example;  // String | Bot ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // show backoffice_bot
                Bot result = apiInstance.backofficeBotShow(id, organisation, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$id = id_example; // String | Bot ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotShow($id, $organisation, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotShow: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $id = id_example; # String | Bot ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
id = id_example # String | Bot ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # show backoffice_bot
    api_response = api_instance.backoffice_bot_show(id, organisation, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotShow: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBotShowBatchUpdate

show_batch_update backoffice_bot

Show bot batch update.


/0.0.1/backoffice/bots/batch_updates/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/batch_updates/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot batch update ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_batch_update result = apiInstance.backofficeBotShowBatchUpdate(id, organisation, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowBatchUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot batch update ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_batch_update result = apiInstance.backofficeBotShowBatchUpdate(id, organisation, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowBatchUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Bot batch update ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// show_batch_update backoffice_bot
[apiInstance backofficeBotShowBatchUpdateWith:id
    organisation:organisation
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot_batch_update output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var id = id_example; // {String} Bot batch update ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotShowBatchUpdate(id, organisation, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotShowBatchUpdateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var id = id_example;  // String | Bot batch update ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // show_batch_update backoffice_bot
                Bot_batch_update result = apiInstance.backofficeBotShowBatchUpdate(id, organisation, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotShowBatchUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$id = id_example; // String | Bot batch update ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotShowBatchUpdate($id, $organisation, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotShowBatchUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $id = id_example; # String | Bot batch update ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
id = id_example # String | Bot batch update ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # show_batch_update backoffice_bot
    api_response = api_instance.backoffice_bot_show_batch_update(id, organisation, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotShowBatchUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot batch update ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBotShowChannel

show_channel backoffice_bot

Show bot channel.


/0.0.1/backoffice/bots/{id}/channels/{channelID}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/{id}/channels/{channelID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String channelID = channelID_example; // String | Bot channel ID
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_channel result = apiInstance.backofficeBotShowChannel(channelID, id, organisation, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowChannel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String channelID = channelID_example; // String | Bot channel ID
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_channel result = apiInstance.backofficeBotShowChannel(channelID, id, organisation, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowChannel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *channelID = channelID_example; // Bot channel ID
String *id = id_example; // Bot ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// show_channel backoffice_bot
[apiInstance backofficeBotShowChannelWith:channelID
    id:id
    organisation:organisation
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot_channel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var channelID = channelID_example; // {String} Bot channel ID

var id = id_example; // {String} Bot ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotShowChannel(channelID, id, organisation, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotShowChannelExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var channelID = channelID_example;  // String | Bot channel ID
            var id = id_example;  // String | Bot ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // show_channel backoffice_bot
                Bot_channel result = apiInstance.backofficeBotShowChannel(channelID, id, organisation, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotShowChannel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$channelID = channelID_example; // String | Bot channel ID
$id = id_example; // String | Bot ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotShowChannel($channelID, $id, $organisation, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotShowChannel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $channelID = channelID_example; # String | Bot channel ID
my $id = id_example; # String | Bot ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotShowChannel(channelID => $channelID, id => $id, organisation => $organisation, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotShowChannel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
channelID = channelID_example # String | Bot channel ID
id = id_example # String | Bot ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # show_channel backoffice_bot
    api_response = api_instance.backoffice_bot_show_channel(channelID, id, organisation, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotShowChannel: %s\n" % e)

Parameters

Path parameters
Name Description
channelID*
String
Bot channel ID
Required
id*
String
Bot ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBotShowDownloadList

show_download_list backoffice_bot

Retrieve bot list download.


/0.0.1/backoffice/bots/list/download/{downloadID}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/list/download/{downloadID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String downloadID = downloadID_example; // String | Download ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Download result = apiInstance.backofficeBotShowDownloadList(downloadID, organisation, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowDownloadList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String downloadID = downloadID_example; // String | Download ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Download result = apiInstance.backofficeBotShowDownloadList(downloadID, organisation, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowDownloadList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *downloadID = downloadID_example; // Download ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// show_download_list backoffice_bot
[apiInstance backofficeBotShowDownloadListWith:downloadID
    organisation:organisation
    acceptLanguage:acceptLanguage
              completionHandler: ^(Download output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var downloadID = downloadID_example; // {String} Download ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotShowDownloadList(downloadID, organisation, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotShowDownloadListExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var downloadID = downloadID_example;  // String | Download ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // show_download_list backoffice_bot
                Download result = apiInstance.backofficeBotShowDownloadList(downloadID, organisation, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotShowDownloadList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$downloadID = downloadID_example; // String | Download ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotShowDownloadList($downloadID, $organisation, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotShowDownloadList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $downloadID = downloadID_example; # String | Download ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotShowDownloadList(downloadID => $downloadID, organisation => $organisation, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotShowDownloadList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
downloadID = downloadID_example # String | Download ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # show_download_list backoffice_bot
    api_response = api_instance.backoffice_bot_show_download_list(downloadID, organisation, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotShowDownloadList: %s\n" % e)

Parameters

Path parameters
Name Description
downloadID*
String
Download ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBotShowDownloadResponses

show_download_responses backoffice_bot

Retrieve bot responses download.


/0.0.1/backoffice/bots/responses/download/{downloadID}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/responses/download/{downloadID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String downloadID = downloadID_example; // String | Download ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Download result = apiInstance.backofficeBotShowDownloadResponses(downloadID, organisation, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowDownloadResponses");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String downloadID = downloadID_example; // String | Download ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Download result = apiInstance.backofficeBotShowDownloadResponses(downloadID, organisation, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowDownloadResponses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *downloadID = downloadID_example; // Download ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// show_download_responses backoffice_bot
[apiInstance backofficeBotShowDownloadResponsesWith:downloadID
    organisation:organisation
    acceptLanguage:acceptLanguage
              completionHandler: ^(Download output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var downloadID = downloadID_example; // {String} Download ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotShowDownloadResponses(downloadID, organisation, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotShowDownloadResponsesExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var downloadID = downloadID_example;  // String | Download ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // show_download_responses backoffice_bot
                Download result = apiInstance.backofficeBotShowDownloadResponses(downloadID, organisation, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotShowDownloadResponses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$downloadID = downloadID_example; // String | Download ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotShowDownloadResponses($downloadID, $organisation, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotShowDownloadResponses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $downloadID = downloadID_example; # String | Download ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotShowDownloadResponses(downloadID => $downloadID, organisation => $organisation, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotShowDownloadResponses: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
downloadID = downloadID_example # String | Download ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # show_download_responses backoffice_bot
    api_response = api_instance.backoffice_bot_show_download_responses(downloadID, organisation, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotShowDownloadResponses: %s\n" % e)

Parameters

Path parameters
Name Description
downloadID*
String
Download ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBotShowDropoffReport

show_dropoff_report backoffice_bot

Retrieve bot drop off report.


/0.0.1/backoffice/bots/{id}/reports/dropoff

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/{id}/reports/dropoff"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        BotDropOffReportPayload payload = ; // BotDropOffReportPayload | Bot drop off report payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_drop_off_report result = apiInstance.backofficeBotShowDropoffReport(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowDropoffReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        BotDropOffReportPayload payload = ; // BotDropOffReportPayload | Bot drop off report payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_drop_off_report result = apiInstance.backofficeBotShowDropoffReport(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowDropoffReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Bot ID
String *organisation = organisation_example; // 
BotDropOffReportPayload *payload = ; // Bot drop off report payload
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// show_dropoff_report backoffice_bot
[apiInstance backofficeBotShowDropoffReportWith:id
    organisation:organisation
    payload:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot_drop_off_report output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var id = id_example; // {String} Bot ID

var organisation = organisation_example; // {String} 

var payload = ; // {BotDropOffReportPayload} Bot drop off report payload

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotShowDropoffReport(id, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotShowDropoffReportExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var id = id_example;  // String | Bot ID
            var organisation = organisation_example;  // String | 
            var payload = new BotDropOffReportPayload(); // BotDropOffReportPayload | Bot drop off report payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // show_dropoff_report backoffice_bot
                Bot_drop_off_report result = apiInstance.backofficeBotShowDropoffReport(id, organisation, payload, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotShowDropoffReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$id = id_example; // String | Bot ID
$organisation = organisation_example; // String | 
$payload = ; // BotDropOffReportPayload | Bot drop off report payload
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotShowDropoffReport($id, $organisation, $payload, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotShowDropoffReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $id = id_example; # String | Bot ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::BotDropOffReportPayload->new(); # BotDropOffReportPayload | Bot drop off report payload
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotShowDropoffReport(id => $id, organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotShowDropoffReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
id = id_example # String | Bot ID
organisation = organisation_example # String | 
payload =  # BotDropOffReportPayload | Bot drop off report payload
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # show_dropoff_report backoffice_bot
    api_response = api_instance.backoffice_bot_show_dropoff_report(id, organisation, payload, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotShowDropoffReport: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeBotShowFeedbackReport

show_feedback_report backoffice_bot

Retrieve bot feedback report.


/0.0.1/backoffice/bots/{id}/reports/feedback

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/{id}/reports/feedback"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        BotFeedbackReportPayload payload = ; // BotFeedbackReportPayload | Bot feedback report payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_feedback_report result = apiInstance.backofficeBotShowFeedbackReport(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowFeedbackReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        BotFeedbackReportPayload payload = ; // BotFeedbackReportPayload | Bot feedback report payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_feedback_report result = apiInstance.backofficeBotShowFeedbackReport(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowFeedbackReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Bot ID
String *organisation = organisation_example; // 
BotFeedbackReportPayload *payload = ; // Bot feedback report payload
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// show_feedback_report backoffice_bot
[apiInstance backofficeBotShowFeedbackReportWith:id
    organisation:organisation
    payload:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot_feedback_report output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var id = id_example; // {String} Bot ID

var organisation = organisation_example; // {String} 

var payload = ; // {BotFeedbackReportPayload} Bot feedback report payload

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotShowFeedbackReport(id, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotShowFeedbackReportExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var id = id_example;  // String | Bot ID
            var organisation = organisation_example;  // String | 
            var payload = new BotFeedbackReportPayload(); // BotFeedbackReportPayload | Bot feedback report payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // show_feedback_report backoffice_bot
                Bot_feedback_report result = apiInstance.backofficeBotShowFeedbackReport(id, organisation, payload, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotShowFeedbackReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$id = id_example; // String | Bot ID
$organisation = organisation_example; // String | 
$payload = ; // BotFeedbackReportPayload | Bot feedback report payload
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotShowFeedbackReport($id, $organisation, $payload, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotShowFeedbackReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $id = id_example; # String | Bot ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::BotFeedbackReportPayload->new(); # BotFeedbackReportPayload | Bot feedback report payload
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotShowFeedbackReport(id => $id, organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotShowFeedbackReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
id = id_example # String | Bot ID
organisation = organisation_example # String | 
payload =  # BotFeedbackReportPayload | Bot feedback report payload
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # show_feedback_report backoffice_bot
    api_response = api_instance.backoffice_bot_show_feedback_report(id, organisation, payload, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotShowFeedbackReport: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeBotShowFunnelReport

show_funnel_report backoffice_bot

Retrieve bot funnel report.


/0.0.1/backoffice/bots/{id}/reports/funnel

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/{id}/reports/funnel"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        BotFunnelReportPayload payload = ; // BotFunnelReportPayload | Bot funnel report payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_funnel_report result = apiInstance.backofficeBotShowFunnelReport(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowFunnelReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        BotFunnelReportPayload payload = ; // BotFunnelReportPayload | Bot funnel report payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_funnel_report result = apiInstance.backofficeBotShowFunnelReport(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowFunnelReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Bot ID
String *organisation = organisation_example; // 
BotFunnelReportPayload *payload = ; // Bot funnel report payload
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// show_funnel_report backoffice_bot
[apiInstance backofficeBotShowFunnelReportWith:id
    organisation:organisation
    payload:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot_funnel_report output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var id = id_example; // {String} Bot ID

var organisation = organisation_example; // {String} 

var payload = ; // {BotFunnelReportPayload} Bot funnel report payload

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotShowFunnelReport(id, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotShowFunnelReportExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var id = id_example;  // String | Bot ID
            var organisation = organisation_example;  // String | 
            var payload = new BotFunnelReportPayload(); // BotFunnelReportPayload | Bot funnel report payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // show_funnel_report backoffice_bot
                Bot_funnel_report result = apiInstance.backofficeBotShowFunnelReport(id, organisation, payload, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotShowFunnelReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$id = id_example; // String | Bot ID
$organisation = organisation_example; // String | 
$payload = ; // BotFunnelReportPayload | Bot funnel report payload
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotShowFunnelReport($id, $organisation, $payload, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotShowFunnelReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $id = id_example; # String | Bot ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::BotFunnelReportPayload->new(); # BotFunnelReportPayload | Bot funnel report payload
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotShowFunnelReport(id => $id, organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotShowFunnelReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
id = id_example # String | Bot ID
organisation = organisation_example # String | 
payload =  # BotFunnelReportPayload | Bot funnel report payload
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # show_funnel_report backoffice_bot
    api_response = api_instance.backoffice_bot_show_funnel_report(id, organisation, payload, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotShowFunnelReport: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeBotShowInteractiveReport

show_interactive_report backoffice_bot

Retrieve bot interactive report.


/0.0.1/backoffice/bots/{id}/reports/interactive

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/{id}/reports/interactive"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        BotInteractiveReportPayload payload = ; // BotInteractiveReportPayload | Bot interactive report payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_interactive_report result = apiInstance.backofficeBotShowInteractiveReport(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowInteractiveReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        BotInteractiveReportPayload payload = ; // BotInteractiveReportPayload | Bot interactive report payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_interactive_report result = apiInstance.backofficeBotShowInteractiveReport(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowInteractiveReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Bot ID
String *organisation = organisation_example; // 
BotInteractiveReportPayload *payload = ; // Bot interactive report payload
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// show_interactive_report backoffice_bot
[apiInstance backofficeBotShowInteractiveReportWith:id
    organisation:organisation
    payload:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot_interactive_report output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var id = id_example; // {String} Bot ID

var organisation = organisation_example; // {String} 

var payload = ; // {BotInteractiveReportPayload} Bot interactive report payload

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotShowInteractiveReport(id, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotShowInteractiveReportExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var id = id_example;  // String | Bot ID
            var organisation = organisation_example;  // String | 
            var payload = new BotInteractiveReportPayload(); // BotInteractiveReportPayload | Bot interactive report payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // show_interactive_report backoffice_bot
                Bot_interactive_report result = apiInstance.backofficeBotShowInteractiveReport(id, organisation, payload, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotShowInteractiveReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$id = id_example; // String | Bot ID
$organisation = organisation_example; // String | 
$payload = ; // BotInteractiveReportPayload | Bot interactive report payload
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotShowInteractiveReport($id, $organisation, $payload, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotShowInteractiveReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $id = id_example; # String | Bot ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::BotInteractiveReportPayload->new(); # BotInteractiveReportPayload | Bot interactive report payload
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotShowInteractiveReport(id => $id, organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotShowInteractiveReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
id = id_example # String | Bot ID
organisation = organisation_example # String | 
payload =  # BotInteractiveReportPayload | Bot interactive report payload
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # show_interactive_report backoffice_bot
    api_response = api_instance.backoffice_bot_show_interactive_report(id, organisation, payload, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotShowInteractiveReport: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeBotShowLocationReport

show_location_report backoffice_bot

Retrieve bot location report.


/0.0.1/backoffice/bots/{id}/reports/location

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/{id}/reports/location"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        BotLocationReportPayload payload = ; // BotLocationReportPayload | Bot location report payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_location_report result = apiInstance.backofficeBotShowLocationReport(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowLocationReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        BotLocationReportPayload payload = ; // BotLocationReportPayload | Bot location report payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_location_report result = apiInstance.backofficeBotShowLocationReport(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowLocationReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Bot ID
String *organisation = organisation_example; // 
BotLocationReportPayload *payload = ; // Bot location report payload
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// show_location_report backoffice_bot
[apiInstance backofficeBotShowLocationReportWith:id
    organisation:organisation
    payload:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot_location_report output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var id = id_example; // {String} Bot ID

var organisation = organisation_example; // {String} 

var payload = ; // {BotLocationReportPayload} Bot location report payload

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotShowLocationReport(id, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotShowLocationReportExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var id = id_example;  // String | Bot ID
            var organisation = organisation_example;  // String | 
            var payload = new BotLocationReportPayload(); // BotLocationReportPayload | Bot location report payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // show_location_report backoffice_bot
                Bot_location_report result = apiInstance.backofficeBotShowLocationReport(id, organisation, payload, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotShowLocationReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$id = id_example; // String | Bot ID
$organisation = organisation_example; // String | 
$payload = ; // BotLocationReportPayload | Bot location report payload
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotShowLocationReport($id, $organisation, $payload, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotShowLocationReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $id = id_example; # String | Bot ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::BotLocationReportPayload->new(); # BotLocationReportPayload | Bot location report payload
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotShowLocationReport(id => $id, organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotShowLocationReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
id = id_example # String | Bot ID
organisation = organisation_example # String | 
payload =  # BotLocationReportPayload | Bot location report payload
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # show_location_report backoffice_bot
    api_response = api_instance.backoffice_bot_show_location_report(id, organisation, payload, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotShowLocationReport: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeBotShowMonitoringReport

show_monitoring_report backoffice_bot

Retrieve bot monitoring report.


/0.0.1/backoffice/bots/{id}/reports/monitoring

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/{id}/reports/monitoring"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        BotMonitoringReportPayload payload = ; // BotMonitoringReportPayload | Bot monitoring report payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_monitoring_report result = apiInstance.backofficeBotShowMonitoringReport(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowMonitoringReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        BotMonitoringReportPayload payload = ; // BotMonitoringReportPayload | Bot monitoring report payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_monitoring_report result = apiInstance.backofficeBotShowMonitoringReport(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowMonitoringReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Bot ID
String *organisation = organisation_example; // 
BotMonitoringReportPayload *payload = ; // Bot monitoring report payload
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// show_monitoring_report backoffice_bot
[apiInstance backofficeBotShowMonitoringReportWith:id
    organisation:organisation
    payload:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot_monitoring_report output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var id = id_example; // {String} Bot ID

var organisation = organisation_example; // {String} 

var payload = ; // {BotMonitoringReportPayload} Bot monitoring report payload

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotShowMonitoringReport(id, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotShowMonitoringReportExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var id = id_example;  // String | Bot ID
            var organisation = organisation_example;  // String | 
            var payload = new BotMonitoringReportPayload(); // BotMonitoringReportPayload | Bot monitoring report payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // show_monitoring_report backoffice_bot
                Bot_monitoring_report result = apiInstance.backofficeBotShowMonitoringReport(id, organisation, payload, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotShowMonitoringReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$id = id_example; // String | Bot ID
$organisation = organisation_example; // String | 
$payload = ; // BotMonitoringReportPayload | Bot monitoring report payload
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotShowMonitoringReport($id, $organisation, $payload, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotShowMonitoringReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $id = id_example; # String | Bot ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::BotMonitoringReportPayload->new(); # BotMonitoringReportPayload | Bot monitoring report payload
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotShowMonitoringReport(id => $id, organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotShowMonitoringReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
id = id_example # String | Bot ID
organisation = organisation_example # String | 
payload =  # BotMonitoringReportPayload | Bot monitoring report payload
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # show_monitoring_report backoffice_bot
    api_response = api_instance.backoffice_bot_show_monitoring_report(id, organisation, payload, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotShowMonitoringReport: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeBotShowProgressReport

show_progress_report backoffice_bot

Retrieve bot progress over time report.


/0.0.1/backoffice/bots/{id}/reports/progress

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/{id}/reports/progress"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        BotProgressReportPayload payload = ; // BotProgressReportPayload | Bot progress report payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_progress_report result = apiInstance.backofficeBotShowProgressReport(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowProgressReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        BotProgressReportPayload payload = ; // BotProgressReportPayload | Bot progress report payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_progress_report result = apiInstance.backofficeBotShowProgressReport(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowProgressReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Bot ID
String *organisation = organisation_example; // 
BotProgressReportPayload *payload = ; // Bot progress report payload
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// show_progress_report backoffice_bot
[apiInstance backofficeBotShowProgressReportWith:id
    organisation:organisation
    payload:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot_progress_report output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var id = id_example; // {String} Bot ID

var organisation = organisation_example; // {String} 

var payload = ; // {BotProgressReportPayload} Bot progress report payload

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotShowProgressReport(id, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotShowProgressReportExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var id = id_example;  // String | Bot ID
            var organisation = organisation_example;  // String | 
            var payload = new BotProgressReportPayload(); // BotProgressReportPayload | Bot progress report payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // show_progress_report backoffice_bot
                Bot_progress_report result = apiInstance.backofficeBotShowProgressReport(id, organisation, payload, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotShowProgressReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$id = id_example; // String | Bot ID
$organisation = organisation_example; // String | 
$payload = ; // BotProgressReportPayload | Bot progress report payload
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotShowProgressReport($id, $organisation, $payload, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotShowProgressReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $id = id_example; # String | Bot ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::BotProgressReportPayload->new(); # BotProgressReportPayload | Bot progress report payload
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotShowProgressReport(id => $id, organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotShowProgressReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
id = id_example # String | Bot ID
organisation = organisation_example # String | 
payload =  # BotProgressReportPayload | Bot progress report payload
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # show_progress_report backoffice_bot
    api_response = api_instance.backoffice_bot_show_progress_report(id, organisation, payload, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotShowProgressReport: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeBotShowResponse

show_response backoffice_bot

Retrieve bot response.


/0.0.1/backoffice/bots/{id}/responses/{responseID}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/{id}/responses/{responseID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String responseID = responseID_example; // String | Response ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_response result = apiInstance.backofficeBotShowResponse(id, responseID, organisation, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowResponse");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String responseID = responseID_example; // String | Response ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_response result = apiInstance.backofficeBotShowResponse(id, responseID, organisation, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowResponse");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Bot ID
String *responseID = responseID_example; // Response ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// show_response backoffice_bot
[apiInstance backofficeBotShowResponseWith:id
    responseID:responseID
    organisation:organisation
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot_response output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var id = id_example; // {String} Bot ID

var responseID = responseID_example; // {String} Response ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotShowResponse(id, responseID, organisation, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotShowResponseExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var id = id_example;  // String | Bot ID
            var responseID = responseID_example;  // String | Response ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // show_response backoffice_bot
                Bot_response result = apiInstance.backofficeBotShowResponse(id, responseID, organisation, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotShowResponse: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$id = id_example; // String | Bot ID
$responseID = responseID_example; // String | Response ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotShowResponse($id, $responseID, $organisation, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotShowResponse: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $id = id_example; # String | Bot ID
my $responseID = responseID_example; # String | Response ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotShowResponse(id => $id, responseID => $responseID, organisation => $organisation, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotShowResponse: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
id = id_example # String | Bot ID
responseID = responseID_example # String | Response ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # show_response backoffice_bot
    api_response = api_instance.backoffice_bot_show_response(id, responseID, organisation, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotShowResponse: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot ID
Required
responseID*
String
Response ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeBotShowResponseActionLogItems

show_response_action_log_items backoffice_bot

Retrieve bot response actions log items.


/0.0.1/backoffice/bots/{id}/response_actions/{responseActionID}/log_items/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/{id}/response_actions/{responseActionID}/log_items/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String responseActionID = responseActionID_example; // String | Response action ID
        String organisation = organisation_example; // String | 
        BotResponseActionLogItemCollectionPayload payload = ; // BotResponseActionLogItemCollectionPayload | Bot response actions log item collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_response_action_log_item_collection result = apiInstance.backofficeBotShowResponseActionLogItems(id, responseActionID, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowResponseActionLogItems");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String responseActionID = responseActionID_example; // String | Response action ID
        String organisation = organisation_example; // String | 
        BotResponseActionLogItemCollectionPayload payload = ; // BotResponseActionLogItemCollectionPayload | Bot response actions log item collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_response_action_log_item_collection result = apiInstance.backofficeBotShowResponseActionLogItems(id, responseActionID, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowResponseActionLogItems");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Bot ID
String *responseActionID = responseActionID_example; // Response action ID
String *organisation = organisation_example; // 
BotResponseActionLogItemCollectionPayload *payload = ; // Bot response actions log item collection payload
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// show_response_action_log_items backoffice_bot
[apiInstance backofficeBotShowResponseActionLogItemsWith:id
    responseActionID:responseActionID
    organisation:organisation
    payload:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot_response_action_log_item_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var id = id_example; // {String} Bot ID

var responseActionID = responseActionID_example; // {String} Response action ID

var organisation = organisation_example; // {String} 

var payload = ; // {BotResponseActionLogItemCollectionPayload} Bot response actions log item collection payload

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotShowResponseActionLogItems(id, responseActionID, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotShowResponseActionLogItemsExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var id = id_example;  // String | Bot ID
            var responseActionID = responseActionID_example;  // String | Response action ID
            var organisation = organisation_example;  // String | 
            var payload = new BotResponseActionLogItemCollectionPayload(); // BotResponseActionLogItemCollectionPayload | Bot response actions log item collection payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // show_response_action_log_items backoffice_bot
                Bot_response_action_log_item_collection result = apiInstance.backofficeBotShowResponseActionLogItems(id, responseActionID, organisation, payload, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotShowResponseActionLogItems: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$id = id_example; // String | Bot ID
$responseActionID = responseActionID_example; // String | Response action ID
$organisation = organisation_example; // String | 
$payload = ; // BotResponseActionLogItemCollectionPayload | Bot response actions log item collection payload
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotShowResponseActionLogItems($id, $responseActionID, $organisation, $payload, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotShowResponseActionLogItems: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $id = id_example; # String | Bot ID
my $responseActionID = responseActionID_example; # String | Response action ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::BotResponseActionLogItemCollectionPayload->new(); # BotResponseActionLogItemCollectionPayload | Bot response actions log item collection payload
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotShowResponseActionLogItems(id => $id, responseActionID => $responseActionID, organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotShowResponseActionLogItems: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
id = id_example # String | Bot ID
responseActionID = responseActionID_example # String | Response action ID
organisation = organisation_example # String | 
payload =  # BotResponseActionLogItemCollectionPayload | Bot response actions log item collection payload
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # show_response_action_log_items backoffice_bot
    api_response = api_instance.backoffice_bot_show_response_action_log_items(id, responseActionID, organisation, payload, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotShowResponseActionLogItems: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot ID
Required
responseActionID*
String
Response action ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeBotShowResponses

show_responses backoffice_bot

Retrieve bot responses.


/0.0.1/backoffice/bots/responses/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/responses/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String organisation = organisation_example; // String | 
        BotResponseCollectionPayload payload = ; // BotResponseCollectionPayload | Bot response collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_response_collection result = apiInstance.backofficeBotShowResponses(organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowResponses");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String organisation = organisation_example; // String | 
        BotResponseCollectionPayload payload = ; // BotResponseCollectionPayload | Bot response collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_response_collection result = apiInstance.backofficeBotShowResponses(organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowResponses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
BotResponseCollectionPayload *payload = ; // Bot response collection payload
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// show_responses backoffice_bot
[apiInstance backofficeBotShowResponsesWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot_response_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var organisation = organisation_example; // {String} 

var payload = ; // {BotResponseCollectionPayload} Bot response collection payload

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotShowResponses(organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotShowResponsesExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var organisation = organisation_example;  // String | 
            var payload = new BotResponseCollectionPayload(); // BotResponseCollectionPayload | Bot response collection payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // show_responses backoffice_bot
                Bot_response_collection result = apiInstance.backofficeBotShowResponses(organisation, payload, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotShowResponses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$organisation = organisation_example; // String | 
$payload = ; // BotResponseCollectionPayload | Bot response collection payload
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotShowResponses($organisation, $payload, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotShowResponses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::BotResponseCollectionPayload->new(); # BotResponseCollectionPayload | Bot response collection payload
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotShowResponses(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotShowResponses: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
organisation = organisation_example # String | 
payload =  # BotResponseCollectionPayload | Bot response collection payload
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # show_responses backoffice_bot
    api_response = api_instance.backoffice_bot_show_responses(organisation, payload, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotShowResponses: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeBotShowStats

show_stats backoffice_bot

Retrieve bot stats.


/0.0.1/backoffice/bots/{id}/reports/stats

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/{id}/reports/stats"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        BotStatsReportPayload payload = ; // BotStatsReportPayload | Bot stats report payload
        try {
            Bot_stats result = apiInstance.backofficeBotShowStats(id, organisation, acceptLanguage, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowStats");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        BotStatsReportPayload payload = ; // BotStatsReportPayload | Bot stats report payload
        try {
            Bot_stats result = apiInstance.backofficeBotShowStats(id, organisation, acceptLanguage, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotShowStats");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Bot ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)
BotStatsReportPayload *payload = ; // Bot stats report payload (optional)

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

// show_stats backoffice_bot
[apiInstance backofficeBotShowStatsWith:id
    organisation:organisation
    acceptLanguage:acceptLanguage
    payload:payload
              completionHandler: ^(Bot_stats output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var id = id_example; // {String} Bot ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'payload':  // {BotStatsReportPayload} Bot stats report payload
};
api.backofficeBotShowStats(id, organisation, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotShowStatsExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var id = id_example;  // String | Bot ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var payload = new BotStatsReportPayload(); // BotStatsReportPayload | Bot stats report payload (optional) 

            try
            {
                // show_stats backoffice_bot
                Bot_stats result = apiInstance.backofficeBotShowStats(id, organisation, acceptLanguage, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotShowStats: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$id = id_example; // String | Bot ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 
$payload = ; // BotStatsReportPayload | Bot stats report payload

try {
    $result = $api_instance->backofficeBotShowStats($id, $organisation, $acceptLanguage, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotShowStats: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $id = id_example; # String | Bot ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 
my $payload = WWW::SwaggerClient::Object::BotStatsReportPayload->new(); # BotStatsReportPayload | Bot stats report payload

eval { 
    my $result = $api_instance->backofficeBotShowStats(id => $id, organisation => $organisation, acceptLanguage => $acceptLanguage, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotShowStats: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
id = id_example # String | Bot ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)
payload =  # BotStatsReportPayload | Bot stats report payload (optional)

try: 
    # show_stats backoffice_bot
    api_response = api_instance.backoffice_bot_show_stats(id, organisation, acceptLanguage=acceptLanguage, payload=payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotShowStats: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeBotTransfer

transfer backoffice_bot

Transfer the bot


/0.0.1/backoffice/bots/{id}/transfer

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/{id}/transfer"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        BotTransferPayload payload = ; // BotTransferPayload | Bot transfer payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot result = apiInstance.backofficeBotTransfer(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotTransfer");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        BotTransferPayload payload = ; // BotTransferPayload | Bot transfer payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot result = apiInstance.backofficeBotTransfer(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotTransfer");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Bot ID
String *organisation = organisation_example; // 
BotTransferPayload *payload = ; // Bot transfer payload
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// transfer backoffice_bot
[apiInstance backofficeBotTransferWith:id
    organisation:organisation
    payload:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var id = id_example; // {String} Bot ID

var organisation = organisation_example; // {String} 

var payload = ; // {BotTransferPayload} Bot transfer payload

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotTransfer(id, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotTransferExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var id = id_example;  // String | Bot ID
            var organisation = organisation_example;  // String | 
            var payload = new BotTransferPayload(); // BotTransferPayload | Bot transfer payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // transfer backoffice_bot
                Bot result = apiInstance.backofficeBotTransfer(id, organisation, payload, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotTransfer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$id = id_example; // String | Bot ID
$organisation = organisation_example; // String | 
$payload = ; // BotTransferPayload | Bot transfer payload
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotTransfer($id, $organisation, $payload, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotTransfer: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $id = id_example; # String | Bot ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::BotTransferPayload->new(); # BotTransferPayload | Bot transfer payload
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotTransfer(id => $id, organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotTransfer: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
id = id_example # String | Bot ID
organisation = organisation_example # String | 
payload =  # BotTransferPayload | Bot transfer payload
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # transfer backoffice_bot
    api_response = api_instance.backoffice_bot_transfer(id, organisation, payload, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotTransfer: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBotUnlaunchChannel

unlaunch_channel backoffice_bot

Unlaunch bot channel.


/0.0.1/backoffice/bots/{id}/channels/{channelID}/unlaunch

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/{id}/channels/{channelID}/unlaunch"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String channelID = channelID_example; // String | Bot channel ID
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_channel result = apiInstance.backofficeBotUnlaunchChannel(channelID, id, organisation, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotUnlaunchChannel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String channelID = channelID_example; // String | Bot channel ID
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_channel result = apiInstance.backofficeBotUnlaunchChannel(channelID, id, organisation, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotUnlaunchChannel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *channelID = channelID_example; // Bot channel ID
String *id = id_example; // Bot ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// unlaunch_channel backoffice_bot
[apiInstance backofficeBotUnlaunchChannelWith:channelID
    id:id
    organisation:organisation
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot_channel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var channelID = channelID_example; // {String} Bot channel ID

var id = id_example; // {String} Bot ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotUnlaunchChannel(channelID, id, organisation, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotUnlaunchChannelExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var channelID = channelID_example;  // String | Bot channel ID
            var id = id_example;  // String | Bot ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // unlaunch_channel backoffice_bot
                Bot_channel result = apiInstance.backofficeBotUnlaunchChannel(channelID, id, organisation, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotUnlaunchChannel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$channelID = channelID_example; // String | Bot channel ID
$id = id_example; // String | Bot ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotUnlaunchChannel($channelID, $id, $organisation, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotUnlaunchChannel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $channelID = channelID_example; # String | Bot channel ID
my $id = id_example; # String | Bot ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotUnlaunchChannel(channelID => $channelID, id => $id, organisation => $organisation, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotUnlaunchChannel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
channelID = channelID_example # String | Bot channel ID
id = id_example # String | Bot ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # unlaunch_channel backoffice_bot
    api_response = api_instance.backoffice_bot_unlaunch_channel(channelID, id, organisation, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotUnlaunchChannel: %s\n" % e)

Parameters

Path parameters
Name Description
channelID*
String
Bot channel ID
Required
id*
String
Bot ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBotUpdate

update backoffice_bot

Change bot


/0.0.1/backoffice/bots/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        BotUpdatePayload payload = ; // BotUpdatePayload | Bot update payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot result = apiInstance.backofficeBotUpdate(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        BotUpdatePayload payload = ; // BotUpdatePayload | Bot update payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot result = apiInstance.backofficeBotUpdate(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Bot ID
String *organisation = organisation_example; // 
BotUpdatePayload *payload = ; // Bot update payload
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// update backoffice_bot
[apiInstance backofficeBotUpdateWith:id
    organisation:organisation
    payload:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var id = id_example; // {String} Bot ID

var organisation = organisation_example; // {String} 

var payload = ; // {BotUpdatePayload} Bot update payload

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotUpdate(id, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotUpdateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var id = id_example;  // String | Bot ID
            var organisation = organisation_example;  // String | 
            var payload = new BotUpdatePayload(); // BotUpdatePayload | Bot update payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // update backoffice_bot
                Bot result = apiInstance.backofficeBotUpdate(id, organisation, payload, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$id = id_example; // String | Bot ID
$organisation = organisation_example; // String | 
$payload = ; // BotUpdatePayload | Bot update payload
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotUpdate($id, $organisation, $payload, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $id = id_example; # String | Bot ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::BotUpdatePayload->new(); # BotUpdatePayload | Bot update payload
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotUpdate(id => $id, organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotUpdate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
id = id_example # String | Bot ID
organisation = organisation_example # String | 
payload =  # BotUpdatePayload | Bot update payload
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # update backoffice_bot
    api_response = api_instance.backoffice_bot_update(id, organisation, payload, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBotUpdateBatchUpdate

update_batch_update backoffice_bot

Update bot batch update.


/0.0.1/backoffice/bots/batch_updates/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/batch_updates/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot batch update ID
        String organisation = organisation_example; // String | 
        BotBatchUpdatePayload payload = ; // BotBatchUpdatePayload | Bot batch update payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_batch_update result = apiInstance.backofficeBotUpdateBatchUpdate(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotUpdateBatchUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String id = id_example; // String | Bot batch update ID
        String organisation = organisation_example; // String | 
        BotBatchUpdatePayload payload = ; // BotBatchUpdatePayload | Bot batch update payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_batch_update result = apiInstance.backofficeBotUpdateBatchUpdate(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotUpdateBatchUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Bot batch update ID
String *organisation = organisation_example; // 
BotBatchUpdatePayload *payload = ; // Bot batch update payload
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// update_batch_update backoffice_bot
[apiInstance backofficeBotUpdateBatchUpdateWith:id
    organisation:organisation
    payload:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot_batch_update output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var id = id_example; // {String} Bot batch update ID

var organisation = organisation_example; // {String} 

var payload = ; // {BotBatchUpdatePayload} Bot batch update payload

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotUpdateBatchUpdate(id, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotUpdateBatchUpdateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var id = id_example;  // String | Bot batch update ID
            var organisation = organisation_example;  // String | 
            var payload = new BotBatchUpdatePayload(); // BotBatchUpdatePayload | Bot batch update payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // update_batch_update backoffice_bot
                Bot_batch_update result = apiInstance.backofficeBotUpdateBatchUpdate(id, organisation, payload, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotUpdateBatchUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$id = id_example; // String | Bot batch update ID
$organisation = organisation_example; // String | 
$payload = ; // BotBatchUpdatePayload | Bot batch update payload
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotUpdateBatchUpdate($id, $organisation, $payload, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotUpdateBatchUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $id = id_example; # String | Bot batch update ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::BotBatchUpdatePayload->new(); # BotBatchUpdatePayload | Bot batch update payload
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotUpdateBatchUpdate(id => $id, organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotUpdateBatchUpdate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
id = id_example # String | Bot batch update ID
organisation = organisation_example # String | 
payload =  # BotBatchUpdatePayload | Bot batch update payload
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # update_batch_update backoffice_bot
    api_response = api_instance.backoffice_bot_update_batch_update(id, organisation, payload, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotUpdateBatchUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot batch update ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBotUpdateChannel

update_channel backoffice_bot

Update bot channel.


/0.0.1/backoffice/bots/{id}/channels/{channelID}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bots/{id}/channels/{channelID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotApi;

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

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String channelID = channelID_example; // String | Bot channel ID
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        BotChannelPayload payload = ; // BotChannelPayload | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_channel result = apiInstance.backofficeBotUpdateChannel(channelID, id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotUpdateChannel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotApi;

public class BackofficeBotApiExample {

    public static void main(String[] args) {
        BackofficeBotApi apiInstance = new BackofficeBotApi();
        String channelID = channelID_example; // String | Bot channel ID
        String id = id_example; // String | Bot ID
        String organisation = organisation_example; // String | 
        BotChannelPayload payload = ; // BotChannelPayload | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_channel result = apiInstance.backofficeBotUpdateChannel(channelID, id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotApi#backofficeBotUpdateChannel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *channelID = channelID_example; // Bot channel ID
String *id = id_example; // Bot ID
String *organisation = organisation_example; // 
BotChannelPayload *payload = ; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// update_channel backoffice_bot
[apiInstance backofficeBotUpdateChannelWith:channelID
    id:id
    organisation:organisation
    payload:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot_channel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBotApi()

var channelID = channelID_example; // {String} Bot channel ID

var id = id_example; // {String} Bot ID

var organisation = organisation_example; // {String} 

var payload = ; // {BotChannelPayload} 

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotUpdateChannel(channelID, id, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotUpdateChannelExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBotApi();
            var channelID = channelID_example;  // String | Bot channel ID
            var id = id_example;  // String | Bot ID
            var organisation = organisation_example;  // String | 
            var payload = new BotChannelPayload(); // BotChannelPayload | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // update_channel backoffice_bot
                Bot_channel result = apiInstance.backofficeBotUpdateChannel(channelID, id, organisation, payload, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotApi.backofficeBotUpdateChannel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBotApi();
$channelID = channelID_example; // String | Bot channel ID
$id = id_example; // String | Bot ID
$organisation = organisation_example; // String | 
$payload = ; // BotChannelPayload | 
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotUpdateChannel($channelID, $id, $organisation, $payload, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotApi->backofficeBotUpdateChannel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBotApi->new();
my $channelID = channelID_example; # String | Bot channel ID
my $id = id_example; # String | Bot ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::BotChannelPayload->new(); # BotChannelPayload | 
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotUpdateChannel(channelID => $channelID, id => $id, organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotApi->backofficeBotUpdateChannel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBotApi()
channelID = channelID_example # String | Bot channel ID
id = id_example # String | Bot ID
organisation = organisation_example # String | 
payload =  # BotChannelPayload | 
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # update_channel backoffice_bot
    api_response = api_instance.backoffice_bot_update_channel(channelID, id, organisation, payload, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotApi->backofficeBotUpdateChannel: %s\n" % e)

Parameters

Path parameters
Name Description
channelID*
String
Bot channel ID
Required
id*
String
Bot ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


BackofficeBotChannel

backofficeBotChannelAuthorizeChannel

authorize_channel backoffice_bot_channel

Authorize bot channel.


/0.0.1/backoffice/bot_channels/oauth_callback/{type}

Usage and SDK Samples

curl -X GET "https://api.quriobot.com/0.0.1/backoffice/bot_channels/oauth_callback/{type}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotChannelApi;

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

public class BackofficeBotChannelApiExample {

    public static void main(String[] args) {
        
        BackofficeBotChannelApi apiInstance = new BackofficeBotChannelApi();
        String type = type_example; // String | Channel type
        try {
            apiInstance.backofficeBotChannelAuthorizeChannel(type);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotChannelApi#backofficeBotChannelAuthorizeChannel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotChannelApi;

public class BackofficeBotChannelApiExample {

    public static void main(String[] args) {
        BackofficeBotChannelApi apiInstance = new BackofficeBotChannelApi();
        String type = type_example; // String | Channel type
        try {
            apiInstance.backofficeBotChannelAuthorizeChannel(type);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotChannelApi#backofficeBotChannelAuthorizeChannel");
            e.printStackTrace();
        }
    }
}
String *type = type_example; // Channel type

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

// authorize_channel backoffice_bot_channel
[apiInstance backofficeBotChannelAuthorizeChannelWith:type
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.BackofficeBotChannelApi()

var type = type_example; // {String} Channel type

api.backofficeBotChannelAuthorizeChannel(type).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotChannelAuthorizeChannelExample
    {
        public void main()
        {
            
            var apiInstance = new BackofficeBotChannelApi();
            var type = type_example;  // String | Channel type

            try
            {
                // authorize_channel backoffice_bot_channel
                apiInstance.backofficeBotChannelAuthorizeChannel(type);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotChannelApi.backofficeBotChannelAuthorizeChannel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BackofficeBotChannelApi();
$type = type_example; // String | Channel type

try {
    $api_instance->backofficeBotChannelAuthorizeChannel($type);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotChannelApi->backofficeBotChannelAuthorizeChannel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotChannelApi;

my $api_instance = WWW::SwaggerClient::BackofficeBotChannelApi->new();
my $type = type_example; # String | Channel type

eval { 
    $api_instance->backofficeBotChannelAuthorizeChannel(type => $type);
};
if ($@) {
    warn "Exception when calling BackofficeBotChannelApi->backofficeBotChannelAuthorizeChannel: $@\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.BackofficeBotChannelApi()
type = type_example # String | Channel type

try: 
    # authorize_channel backoffice_bot_channel
    api_instance.backoffice_bot_channel_authorize_channel(type)
except ApiException as e:
    print("Exception when calling BackofficeBotChannelApi->backofficeBotChannelAuthorizeChannel: %s\n" % e)

Parameters

Path parameters
Name Description
type*
String
Channel type
Required

Responses

Status: 302 - Redirect

Status: 400 - Bad Request

Status: 403 - Forbidden


BackofficeBotTemplate

backofficeBotTemplateList

list backoffice_bot_template

Retrieve all bot templates.


/0.0.1/backoffice/bot_templates/list

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/backoffice/bot_templates/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotTemplateApi;

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

public class BackofficeBotTemplateApiExample {

    public static void main(String[] args) {
        
        BackofficeBotTemplateApi apiInstance = new BackofficeBotTemplateApi();
        BotTemplateCollectionPayload payload = ; // BotTemplateCollectionPayload | Bot template collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_collection result = apiInstance.backofficeBotTemplateList(payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotTemplateApi#backofficeBotTemplateList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotTemplateApi;

public class BackofficeBotTemplateApiExample {

    public static void main(String[] args) {
        BackofficeBotTemplateApi apiInstance = new BackofficeBotTemplateApi();
        BotTemplateCollectionPayload payload = ; // BotTemplateCollectionPayload | Bot template collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot_collection result = apiInstance.backofficeBotTemplateList(payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotTemplateApi#backofficeBotTemplateList");
            e.printStackTrace();
        }
    }
}
BotTemplateCollectionPayload *payload = ; // Bot template collection payload
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// list backoffice_bot_template
[apiInstance backofficeBotTemplateListWith:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.BackofficeBotTemplateApi()

var payload = ; // {BotTemplateCollectionPayload} Bot template collection payload

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotTemplateList(payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotTemplateListExample
    {
        public void main()
        {
            
            var apiInstance = new BackofficeBotTemplateApi();
            var payload = new BotTemplateCollectionPayload(); // BotTemplateCollectionPayload | Bot template collection payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // list backoffice_bot_template
                Bot_collection result = apiInstance.backofficeBotTemplateList(payload, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotTemplateApi.backofficeBotTemplateList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BackofficeBotTemplateApi();
$payload = ; // BotTemplateCollectionPayload | Bot template collection payload
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeBotTemplateList($payload, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBotTemplateApi->backofficeBotTemplateList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBotTemplateApi;

my $api_instance = WWW::SwaggerClient::BackofficeBotTemplateApi->new();
my $payload = WWW::SwaggerClient::Object::BotTemplateCollectionPayload->new(); # BotTemplateCollectionPayload | Bot template collection payload
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotTemplateList(payload => $payload, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotTemplateApi->backofficeBotTemplateList: $@\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.BackofficeBotTemplateApi()
payload =  # BotTemplateCollectionPayload | Bot template collection payload
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # list backoffice_bot_template
    api_response = api_instance.backoffice_bot_template_list(payload, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotTemplateApi->backofficeBotTemplateList: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeBotTemplateShow

show backoffice_bot_template

Retrieve bot template with given id.


/0.0.1/backoffice/bot_templates/{id}

Usage and SDK Samples

curl -X GET "https://api.quriobot.com/0.0.1/backoffice/bot_templates/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBotTemplateApi;

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

public class BackofficeBotTemplateApiExample {

    public static void main(String[] args) {
        
        BackofficeBotTemplateApi apiInstance = new BackofficeBotTemplateApi();
        String id = id_example; // String | Bot ID
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot result = apiInstance.backofficeBotTemplateShow(id, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotTemplateApi#backofficeBotTemplateShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBotTemplateApi;

public class BackofficeBotTemplateApiExample {

    public static void main(String[] args) {
        BackofficeBotTemplateApi apiInstance = new BackofficeBotTemplateApi();
        String id = id_example; // String | Bot ID
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Bot result = apiInstance.backofficeBotTemplateShow(id, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBotTemplateApi#backofficeBotTemplateShow");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Bot ID
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// show backoffice_bot_template
[apiInstance backofficeBotTemplateShowWith:id
    acceptLanguage:acceptLanguage
              completionHandler: ^(Bot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.BackofficeBotTemplateApi()

var id = id_example; // {String} Bot ID

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeBotTemplateShow(id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBotTemplateShowExample
    {
        public void main()
        {
            
            var apiInstance = new BackofficeBotTemplateApi();
            var id = id_example;  // String | Bot ID
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // show backoffice_bot_template
                Bot result = apiInstance.backofficeBotTemplateShow(id, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBotTemplateApi.backofficeBotTemplateShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BackofficeBotTemplateApi();
$id = id_example; // String | Bot ID
$acceptLanguage = acceptLanguage_example; // String | 

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

my $api_instance = WWW::SwaggerClient::BackofficeBotTemplateApi->new();
my $id = id_example; # String | Bot ID
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeBotTemplateShow(id => $id, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBotTemplateApi->backofficeBotTemplateShow: $@\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.BackofficeBotTemplateApi()
id = id_example # String | Bot ID
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # show backoffice_bot_template
    api_response = api_instance.backoffice_bot_template_show(id, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBotTemplateApi->backofficeBotTemplateShow: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot ID
Required
Header parameters
Name Description
Accept-Language
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


BackofficeBouser

backofficeBouserConfirmPushSubscription

confirm_push_subscription backoffice_bouser

Confirm backoffice user push subscription


/0.0.1/backoffice/bousers/{id}/push_subscriptions/{subscription_id}/confirm

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bousers/{id}/push_subscriptions/{subscription_id}/confirm"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBouserApi;

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

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | Backoffice user ID
        String subscriptionId = subscriptionId_example; // String | Backoffice user push subscription ID
        BoUserPushSubscriptionPayload payload = ; // BoUserPushSubscriptionPayload | Backoffice user push subscription payload
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeBouserConfirmPushSubscription(id, subscriptionId, payload, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserConfirmPushSubscription");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBouserApi;

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | Backoffice user ID
        String subscriptionId = subscriptionId_example; // String | Backoffice user push subscription ID
        BoUserPushSubscriptionPayload payload = ; // BoUserPushSubscriptionPayload | Backoffice user push subscription payload
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeBouserConfirmPushSubscription(id, subscriptionId, payload, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserConfirmPushSubscription");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Backoffice user ID
String *subscriptionId = subscriptionId_example; // Backoffice user push subscription ID
BoUserPushSubscriptionPayload *payload = ; // Backoffice user push subscription payload
String *organisation = organisation_example; //  (optional)

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

// confirm_push_subscription backoffice_bouser
[apiInstance backofficeBouserConfirmPushSubscriptionWith:id
    subscriptionId:subscriptionId
    payload:payload
    organisation:organisation
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBouserApi()

var id = id_example; // {String} Backoffice user ID

var subscriptionId = subscriptionId_example; // {String} Backoffice user push subscription ID

var payload = ; // {BoUserPushSubscriptionPayload} Backoffice user push subscription payload

var opts = { 
  'organisation': organisation_example // {String} 
};
api.backofficeBouserConfirmPushSubscription(id, subscriptionId, payload, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBouserConfirmPushSubscriptionExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBouserApi();
            var id = id_example;  // String | Backoffice user ID
            var subscriptionId = subscriptionId_example;  // String | Backoffice user push subscription ID
            var payload = new BoUserPushSubscriptionPayload(); // BoUserPushSubscriptionPayload | Backoffice user push subscription payload
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // confirm_push_subscription backoffice_bouser
                apiInstance.backofficeBouserConfirmPushSubscription(id, subscriptionId, payload, organisation);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBouserApi.backofficeBouserConfirmPushSubscription: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBouserApi();
$id = id_example; // String | Backoffice user ID
$subscriptionId = subscriptionId_example; // String | Backoffice user push subscription ID
$payload = ; // BoUserPushSubscriptionPayload | Backoffice user push subscription payload
$organisation = organisation_example; // String | 

try {
    $api_instance->backofficeBouserConfirmPushSubscription($id, $subscriptionId, $payload, $organisation);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBouserApi->backofficeBouserConfirmPushSubscription: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBouserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBouserApi->new();
my $id = id_example; # String | Backoffice user ID
my $subscriptionId = subscriptionId_example; # String | Backoffice user push subscription ID
my $payload = WWW::SwaggerClient::Object::BoUserPushSubscriptionPayload->new(); # BoUserPushSubscriptionPayload | Backoffice user push subscription payload
my $organisation = organisation_example; # String | 

eval { 
    $api_instance->backofficeBouserConfirmPushSubscription(id => $id, subscriptionId => $subscriptionId, payload => $payload, organisation => $organisation);
};
if ($@) {
    warn "Exception when calling BackofficeBouserApi->backofficeBouserConfirmPushSubscription: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBouserApi()
id = id_example # String | Backoffice user ID
subscriptionId = subscriptionId_example # String | Backoffice user push subscription ID
payload =  # BoUserPushSubscriptionPayload | Backoffice user push subscription payload
organisation = organisation_example # String |  (optional)

try: 
    # confirm_push_subscription backoffice_bouser
    api_instance.backoffice_bouser_confirm_push_subscription(id, subscriptionId, payload, organisation=organisation)
except ApiException as e:
    print("Exception when calling BackofficeBouserApi->backofficeBouserConfirmPushSubscription: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Backoffice user ID
Required
subscription_id*
String
Backoffice user push subscription ID
Required
Header parameters
Name Description
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBouserConfirmUsernameChange

confirm_username_change backoffice_bouser

Confirm an username change.


/0.0.1/backoffice/bousers/username_changes/confirm

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/backoffice/bousers/username_changes/confirm"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBouserApi;

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

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        
        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        RequestUsernameChangeConfirmPayload payload = ; // RequestUsernameChangeConfirmPayload | A backoffice username change confirmation payload
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Authorized result = apiInstance.backofficeBouserConfirmUsernameChange(payload, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserConfirmUsernameChange");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBouserApi;

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        RequestUsernameChangeConfirmPayload payload = ; // RequestUsernameChangeConfirmPayload | A backoffice username change confirmation payload
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Authorized result = apiInstance.backofficeBouserConfirmUsernameChange(payload, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserConfirmUsernameChange");
            e.printStackTrace();
        }
    }
}
RequestUsernameChangeConfirmPayload *payload = ; // A backoffice username change confirmation payload
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// confirm_username_change backoffice_bouser
[apiInstance backofficeBouserConfirmUsernameChangeWith:payload
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(Authorized output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.BackofficeBouserApi()

var payload = ; // {RequestUsernameChangeConfirmPayload} A backoffice username change confirmation payload

var opts = { 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeBouserConfirmUsernameChange(payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBouserConfirmUsernameChangeExample
    {
        public void main()
        {
            
            var apiInstance = new BackofficeBouserApi();
            var payload = new RequestUsernameChangeConfirmPayload(); // RequestUsernameChangeConfirmPayload | A backoffice username change confirmation payload
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // confirm_username_change backoffice_bouser
                Authorized result = apiInstance.backofficeBouserConfirmUsernameChange(payload, organisation, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBouserApi.backofficeBouserConfirmUsernameChange: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BackofficeBouserApi();
$payload = ; // RequestUsernameChangeConfirmPayload | A backoffice username change confirmation payload
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->backofficeBouserConfirmUsernameChange($payload, $organisation, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBouserApi->backofficeBouserConfirmUsernameChange: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBouserApi;

my $api_instance = WWW::SwaggerClient::BackofficeBouserApi->new();
my $payload = WWW::SwaggerClient::Object::RequestUsernameChangeConfirmPayload->new(); # RequestUsernameChangeConfirmPayload | A backoffice username change confirmation payload
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->backofficeBouserConfirmUsernameChange(payload => $payload, organisation => $organisation, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBouserApi->backofficeBouserConfirmUsernameChange: $@\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.BackofficeBouserApi()
payload =  # RequestUsernameChangeConfirmPayload | A backoffice username change confirmation payload
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # confirm_username_change backoffice_bouser
    api_response = api_instance.backoffice_bouser_confirm_username_change(payload, organisation=organisation, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBouserApi->backofficeBouserConfirmUsernameChange: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation
String
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Name Type Format Description
Authorization String Generated JWT
Authorization-Token-Expires String Expiration of the authorization token

Status: 400 - Bad Request


backofficeBouserCreate

create backoffice_bouser

Create new backoffice user


/0.0.1/backoffice/bousers

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bousers"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBouserApi;

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

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        BoUserCreatePayload payload = ; // BoUserCreatePayload | A backoffice user payload
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user result = apiInstance.backofficeBouserCreate(payload, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserCreate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBouserApi;

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        BoUserCreatePayload payload = ; // BoUserCreatePayload | A backoffice user payload
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user result = apiInstance.backofficeBouserCreate(payload, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

BoUserCreatePayload *payload = ; // A backoffice user payload
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// create backoffice_bouser
[apiInstance backofficeBouserCreateWith:payload
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(Bo_user output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBouserApi()

var payload = ; // {BoUserCreatePayload} A backoffice user payload

var opts = { 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeBouserCreate(payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBouserCreateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBouserApi();
            var payload = new BoUserCreatePayload(); // BoUserCreatePayload | A backoffice user payload
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // create backoffice_bouser
                Bo_user result = apiInstance.backofficeBouserCreate(payload, organisation, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBouserApi.backofficeBouserCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBouserApi();
$payload = ; // BoUserCreatePayload | A backoffice user payload
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->backofficeBouserCreate($payload, $organisation, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBouserApi->backofficeBouserCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBouserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBouserApi->new();
my $payload = WWW::SwaggerClient::Object::BoUserCreatePayload->new(); # BoUserCreatePayload | A backoffice user payload
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->backofficeBouserCreate(payload => $payload, organisation => $organisation, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBouserApi->backofficeBouserCreate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBouserApi()
payload =  # BoUserCreatePayload | A backoffice user payload
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # create backoffice_bouser
    api_response = api_instance.backoffice_bouser_create(payload, organisation=organisation, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBouserApi->backofficeBouserCreate: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation
String
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeBouserCreateApiKey

create_api_key backoffice_bouser

Create new backoffice user API key


/0.0.1/backoffice/bousers/{id}/api_keys

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bousers/{id}/api_keys"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBouserApi;

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

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | 
        BoUserAPIKeyPayload payload = ; // BoUserAPIKeyPayload | Backoffice user API key payload
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user_api_key result = apiInstance.backofficeBouserCreateApiKey(id, payload, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserCreateApiKey");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBouserApi;

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | 
        BoUserAPIKeyPayload payload = ; // BoUserAPIKeyPayload | Backoffice user API key payload
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user_api_key result = apiInstance.backofficeBouserCreateApiKey(id, payload, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserCreateApiKey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // 
BoUserAPIKeyPayload *payload = ; // Backoffice user API key payload
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// create_api_key backoffice_bouser
[apiInstance backofficeBouserCreateApiKeyWith:id
    payload:payload
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(Bo_user_api_key output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBouserApi()

var id = id_example; // {String} 

var payload = ; // {BoUserAPIKeyPayload} Backoffice user API key payload

var opts = { 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeBouserCreateApiKey(id, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBouserCreateApiKeyExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBouserApi();
            var id = id_example;  // String | 
            var payload = new BoUserAPIKeyPayload(); // BoUserAPIKeyPayload | Backoffice user API key payload
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // create_api_key backoffice_bouser
                Bo_user_api_key result = apiInstance.backofficeBouserCreateApiKey(id, payload, organisation, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBouserApi.backofficeBouserCreateApiKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBouserApi();
$id = id_example; // String | 
$payload = ; // BoUserAPIKeyPayload | Backoffice user API key payload
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->backofficeBouserCreateApiKey($id, $payload, $organisation, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBouserApi->backofficeBouserCreateApiKey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBouserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBouserApi->new();
my $id = id_example; # String | 
my $payload = WWW::SwaggerClient::Object::BoUserAPIKeyPayload->new(); # BoUserAPIKeyPayload | Backoffice user API key payload
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->backofficeBouserCreateApiKey(id => $id, payload => $payload, organisation => $organisation, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBouserApi->backofficeBouserCreateApiKey: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBouserApi()
id = id_example # String | 
payload =  # BoUserAPIKeyPayload | Backoffice user API key payload
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # create_api_key backoffice_bouser
    api_response = api_instance.backoffice_bouser_create_api_key(id, payload, organisation=organisation, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBouserApi->backofficeBouserCreateApiKey: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required
Header parameters
Name Description
Organisation
String
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBouserCreateExpoPushSubscription

create_expo_push_subscription backoffice_bouser

Create new backoffice user expo push subscription


/0.0.1/backoffice/bousers/{id}/push_subscriptions/expo

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bousers/{id}/push_subscriptions/expo"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBouserApi;

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

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | 
        BoUserExpoPushSubscriptionPayload payload = ; // BoUserExpoPushSubscriptionPayload | Backoffice user expo push subscription payload
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user_push_subscription result = apiInstance.backofficeBouserCreateExpoPushSubscription(id, payload, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserCreateExpoPushSubscription");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBouserApi;

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | 
        BoUserExpoPushSubscriptionPayload payload = ; // BoUserExpoPushSubscriptionPayload | Backoffice user expo push subscription payload
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user_push_subscription result = apiInstance.backofficeBouserCreateExpoPushSubscription(id, payload, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserCreateExpoPushSubscription");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // 
BoUserExpoPushSubscriptionPayload *payload = ; // Backoffice user expo push subscription payload
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// create_expo_push_subscription backoffice_bouser
[apiInstance backofficeBouserCreateExpoPushSubscriptionWith:id
    payload:payload
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(Bo_user_push_subscription output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBouserApi()

var id = id_example; // {String} 

var payload = ; // {BoUserExpoPushSubscriptionPayload} Backoffice user expo push subscription payload

var opts = { 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeBouserCreateExpoPushSubscription(id, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBouserCreateExpoPushSubscriptionExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBouserApi();
            var id = id_example;  // String | 
            var payload = new BoUserExpoPushSubscriptionPayload(); // BoUserExpoPushSubscriptionPayload | Backoffice user expo push subscription payload
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // create_expo_push_subscription backoffice_bouser
                Bo_user_push_subscription result = apiInstance.backofficeBouserCreateExpoPushSubscription(id, payload, organisation, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBouserApi.backofficeBouserCreateExpoPushSubscription: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBouserApi();
$id = id_example; // String | 
$payload = ; // BoUserExpoPushSubscriptionPayload | Backoffice user expo push subscription payload
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->backofficeBouserCreateExpoPushSubscription($id, $payload, $organisation, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBouserApi->backofficeBouserCreateExpoPushSubscription: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBouserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBouserApi->new();
my $id = id_example; # String | 
my $payload = WWW::SwaggerClient::Object::BoUserExpoPushSubscriptionPayload->new(); # BoUserExpoPushSubscriptionPayload | Backoffice user expo push subscription payload
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->backofficeBouserCreateExpoPushSubscription(id => $id, payload => $payload, organisation => $organisation, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBouserApi->backofficeBouserCreateExpoPushSubscription: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBouserApi()
id = id_example # String | 
payload =  # BoUserExpoPushSubscriptionPayload | Backoffice user expo push subscription payload
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # create_expo_push_subscription backoffice_bouser
    api_response = api_instance.backoffice_bouser_create_expo_push_subscription(id, payload, organisation=organisation, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBouserApi->backofficeBouserCreateExpoPushSubscription: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required
Header parameters
Name Description
Organisation
String
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBouserCreatePushSubscription

create_push_subscription backoffice_bouser

Create new backoffice user push subscription


/0.0.1/backoffice/bousers/{id}/push_subscriptions

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bousers/{id}/push_subscriptions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBouserApi;

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

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | 
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user_push_subscription result = apiInstance.backofficeBouserCreatePushSubscription(id, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserCreatePushSubscription");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBouserApi;

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | 
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user_push_subscription result = apiInstance.backofficeBouserCreatePushSubscription(id, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserCreatePushSubscription");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // 
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// create_push_subscription backoffice_bouser
[apiInstance backofficeBouserCreatePushSubscriptionWith:id
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(Bo_user_push_subscription output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBouserApi()

var id = id_example; // {String} 

var opts = { 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeBouserCreatePushSubscription(id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBouserCreatePushSubscriptionExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBouserApi();
            var id = id_example;  // String | 
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // create_push_subscription backoffice_bouser
                Bo_user_push_subscription result = apiInstance.backofficeBouserCreatePushSubscription(id, organisation, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBouserApi.backofficeBouserCreatePushSubscription: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBouserApi();
$id = id_example; // String | 
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->backofficeBouserCreatePushSubscription($id, $organisation, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBouserApi->backofficeBouserCreatePushSubscription: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBouserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBouserApi->new();
my $id = id_example; # String | 
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBouserApi()
id = id_example # String | 
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # create_push_subscription backoffice_bouser
    api_response = api_instance.backoffice_bouser_create_push_subscription(id, organisation=organisation, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBouserApi->backofficeBouserCreatePushSubscription: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required
Header parameters
Name Description
Organisation
String
X-Forwarded-For
String

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBouserDelete

delete backoffice_bouser


/0.0.1/backoffice/bousers/{id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bousers/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBouserApi;

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

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | Backoffice user ID
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            apiInstance.backofficeBouserDelete(id, organisation, xForwardedFor);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBouserApi;

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | Backoffice user ID
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            apiInstance.backofficeBouserDelete(id, organisation, xForwardedFor);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Backoffice user ID
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// delete backoffice_bouser
[apiInstance backofficeBouserDeleteWith:id
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBouserApi()

var id = id_example; // {String} Backoffice user ID

var opts = { 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeBouserDelete(id, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBouserDeleteExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBouserApi();
            var id = id_example;  // String | Backoffice user ID
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // delete backoffice_bouser
                apiInstance.backofficeBouserDelete(id, organisation, xForwardedFor);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBouserApi.backofficeBouserDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBouserApi();
$id = id_example; // String | Backoffice user ID
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $api_instance->backofficeBouserDelete($id, $organisation, $xForwardedFor);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBouserApi->backofficeBouserDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBouserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBouserApi->new();
my $id = id_example; # String | Backoffice user ID
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    $api_instance->backofficeBouserDelete(id => $id, organisation => $organisation, xForwardedFor => $xForwardedFor);
};
if ($@) {
    warn "Exception when calling BackofficeBouserApi->backofficeBouserDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBouserApi()
id = id_example # String | Backoffice user ID
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # delete backoffice_bouser
    api_instance.backoffice_bouser_delete(id, organisation=organisation, xForwardedFor=xForwardedFor)
except ApiException as e:
    print("Exception when calling BackofficeBouserApi->backofficeBouserDelete: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Backoffice user ID
Required
Header parameters
Name Description
Organisation
String
X-Forwarded-For
String

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBouserDeleteApiKey

delete_api_key backoffice_bouser


/0.0.1/backoffice/bousers/{id}/api_keys/{api_key_id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bousers/{id}/api_keys/{api_key_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBouserApi;

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

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String apiKeyId = apiKeyId_example; // String | Backoffice user API key ID
        String id = id_example; // String | Backoffice user ID
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user result = apiInstance.backofficeBouserDeleteApiKey(apiKeyId, id, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserDeleteApiKey");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBouserApi;

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String apiKeyId = apiKeyId_example; // String | Backoffice user API key ID
        String id = id_example; // String | Backoffice user ID
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user result = apiInstance.backofficeBouserDeleteApiKey(apiKeyId, id, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserDeleteApiKey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *apiKeyId = apiKeyId_example; // Backoffice user API key ID
String *id = id_example; // Backoffice user ID
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// delete_api_key backoffice_bouser
[apiInstance backofficeBouserDeleteApiKeyWith:apiKeyId
    id:id
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(Bo_user output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBouserApi()

var apiKeyId = apiKeyId_example; // {String} Backoffice user API key ID

var id = id_example; // {String} Backoffice user ID

var opts = { 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeBouserDeleteApiKey(apiKeyId, id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBouserDeleteApiKeyExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBouserApi();
            var apiKeyId = apiKeyId_example;  // String | Backoffice user API key ID
            var id = id_example;  // String | Backoffice user ID
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // delete_api_key backoffice_bouser
                Bo_user result = apiInstance.backofficeBouserDeleteApiKey(apiKeyId, id, organisation, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBouserApi.backofficeBouserDeleteApiKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBouserApi();
$apiKeyId = apiKeyId_example; // String | Backoffice user API key ID
$id = id_example; // String | Backoffice user ID
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->backofficeBouserDeleteApiKey($apiKeyId, $id, $organisation, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBouserApi->backofficeBouserDeleteApiKey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBouserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBouserApi->new();
my $apiKeyId = apiKeyId_example; # String | Backoffice user API key ID
my $id = id_example; # String | Backoffice user ID
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->backofficeBouserDeleteApiKey(apiKeyId => $apiKeyId, id => $id, organisation => $organisation, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBouserApi->backofficeBouserDeleteApiKey: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBouserApi()
apiKeyId = apiKeyId_example # String | Backoffice user API key ID
id = id_example # String | Backoffice user ID
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # delete_api_key backoffice_bouser
    api_response = api_instance.backoffice_bouser_delete_api_key(apiKeyId, id, organisation=organisation, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBouserApi->backofficeBouserDeleteApiKey: %s\n" % e)

Parameters

Path parameters
Name Description
api_key_id*
String
Backoffice user API key ID
Required
id*
String
Backoffice user ID
Required
Header parameters
Name Description
Organisation
String
X-Forwarded-For
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBouserDeleteOauth

delete_oauth backoffice_bouser


/0.0.1/backoffice/bousers/{id}/oauth/{oauth_id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bousers/{id}/oauth/{oauth_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBouserApi;

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

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | Backoffice user ID
        String oauthId = oauthId_example; // String | Backoffice user oauth authorization ID
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user result = apiInstance.backofficeBouserDeleteOauth(id, oauthId, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserDeleteOauth");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBouserApi;

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | Backoffice user ID
        String oauthId = oauthId_example; // String | Backoffice user oauth authorization ID
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user result = apiInstance.backofficeBouserDeleteOauth(id, oauthId, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserDeleteOauth");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Backoffice user ID
String *oauthId = oauthId_example; // Backoffice user oauth authorization ID
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// delete_oauth backoffice_bouser
[apiInstance backofficeBouserDeleteOauthWith:id
    oauthId:oauthId
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(Bo_user output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBouserApi()

var id = id_example; // {String} Backoffice user ID

var oauthId = oauthId_example; // {String} Backoffice user oauth authorization ID

var opts = { 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeBouserDeleteOauth(id, oauthId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBouserDeleteOauthExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBouserApi();
            var id = id_example;  // String | Backoffice user ID
            var oauthId = oauthId_example;  // String | Backoffice user oauth authorization ID
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // delete_oauth backoffice_bouser
                Bo_user result = apiInstance.backofficeBouserDeleteOauth(id, oauthId, organisation, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBouserApi.backofficeBouserDeleteOauth: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBouserApi();
$id = id_example; // String | Backoffice user ID
$oauthId = oauthId_example; // String | Backoffice user oauth authorization ID
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->backofficeBouserDeleteOauth($id, $oauthId, $organisation, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBouserApi->backofficeBouserDeleteOauth: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBouserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBouserApi->new();
my $id = id_example; # String | Backoffice user ID
my $oauthId = oauthId_example; # String | Backoffice user oauth authorization ID
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->backofficeBouserDeleteOauth(id => $id, oauthId => $oauthId, organisation => $organisation, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBouserApi->backofficeBouserDeleteOauth: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBouserApi()
id = id_example # String | Backoffice user ID
oauthId = oauthId_example # String | Backoffice user oauth authorization ID
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # delete_oauth backoffice_bouser
    api_response = api_instance.backoffice_bouser_delete_oauth(id, oauthId, organisation=organisation, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBouserApi->backofficeBouserDeleteOauth: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Backoffice user ID
Required
oauth_id*
String
Backoffice user oauth authorization ID
Required
Header parameters
Name Description
Organisation
String
X-Forwarded-For
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBouserDeletePushSubscription

delete_push_subscription backoffice_bouser


/0.0.1/backoffice/bousers/{id}/push_subscriptions/{subscription_id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bousers/{id}/push_subscriptions/{subscription_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBouserApi;

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

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | Backoffice user ID
        String subscriptionId = subscriptionId_example; // String | Backoffice user push subscription ID
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            apiInstance.backofficeBouserDeletePushSubscription(id, subscriptionId, organisation, xForwardedFor);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserDeletePushSubscription");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBouserApi;

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | Backoffice user ID
        String subscriptionId = subscriptionId_example; // String | Backoffice user push subscription ID
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            apiInstance.backofficeBouserDeletePushSubscription(id, subscriptionId, organisation, xForwardedFor);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserDeletePushSubscription");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Backoffice user ID
String *subscriptionId = subscriptionId_example; // Backoffice user push subscription ID
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// delete_push_subscription backoffice_bouser
[apiInstance backofficeBouserDeletePushSubscriptionWith:id
    subscriptionId:subscriptionId
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBouserApi()

var id = id_example; // {String} Backoffice user ID

var subscriptionId = subscriptionId_example; // {String} Backoffice user push subscription ID

var opts = { 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeBouserDeletePushSubscription(id, subscriptionId, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBouserDeletePushSubscriptionExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBouserApi();
            var id = id_example;  // String | Backoffice user ID
            var subscriptionId = subscriptionId_example;  // String | Backoffice user push subscription ID
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // delete_push_subscription backoffice_bouser
                apiInstance.backofficeBouserDeletePushSubscription(id, subscriptionId, organisation, xForwardedFor);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBouserApi.backofficeBouserDeletePushSubscription: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBouserApi();
$id = id_example; // String | Backoffice user ID
$subscriptionId = subscriptionId_example; // String | Backoffice user push subscription ID
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $api_instance->backofficeBouserDeletePushSubscription($id, $subscriptionId, $organisation, $xForwardedFor);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBouserApi->backofficeBouserDeletePushSubscription: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBouserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBouserApi->new();
my $id = id_example; # String | Backoffice user ID
my $subscriptionId = subscriptionId_example; # String | Backoffice user push subscription ID
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    $api_instance->backofficeBouserDeletePushSubscription(id => $id, subscriptionId => $subscriptionId, organisation => $organisation, xForwardedFor => $xForwardedFor);
};
if ($@) {
    warn "Exception when calling BackofficeBouserApi->backofficeBouserDeletePushSubscription: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBouserApi()
id = id_example # String | Backoffice user ID
subscriptionId = subscriptionId_example # String | Backoffice user push subscription ID
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # delete_push_subscription backoffice_bouser
    api_instance.backoffice_bouser_delete_push_subscription(id, subscriptionId, organisation=organisation, xForwardedFor=xForwardedFor)
except ApiException as e:
    print("Exception when calling BackofficeBouserApi->backofficeBouserDeletePushSubscription: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Backoffice user ID
Required
subscription_id*
String
Backoffice user push subscription ID
Required
Header parameters
Name Description
Organisation
String
X-Forwarded-For
String

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBouserList

list backoffice_bouser

Retrieve all backoffice users.


/0.0.1/backoffice/bousers/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bousers/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBouserApi;

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

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        BoUserCollectionPayload payload = ; // BoUserCollectionPayload | User collection payload
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user_collection result = apiInstance.backofficeBouserList(payload, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBouserApi;

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        BoUserCollectionPayload payload = ; // BoUserCollectionPayload | User collection payload
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user_collection result = apiInstance.backofficeBouserList(payload, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

BoUserCollectionPayload *payload = ; // User collection payload
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// list backoffice_bouser
[apiInstance backofficeBouserListWith:payload
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(Bo_user_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBouserApi()

var payload = ; // {BoUserCollectionPayload} User collection payload

var opts = { 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeBouserList(payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBouserListExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBouserApi();
            var payload = new BoUserCollectionPayload(); // BoUserCollectionPayload | User collection payload
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // list backoffice_bouser
                Bo_user_collection result = apiInstance.backofficeBouserList(payload, organisation, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBouserApi.backofficeBouserList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBouserApi();
$payload = ; // BoUserCollectionPayload | User collection payload
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->backofficeBouserList($payload, $organisation, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBouserApi->backofficeBouserList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBouserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBouserApi->new();
my $payload = WWW::SwaggerClient::Object::BoUserCollectionPayload->new(); # BoUserCollectionPayload | User collection payload
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->backofficeBouserList(payload => $payload, organisation => $organisation, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBouserApi->backofficeBouserList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBouserApi()
payload =  # BoUserCollectionPayload | User collection payload
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # list backoffice_bouser
    api_response = api_instance.backoffice_bouser_list(payload, organisation=organisation, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBouserApi->backofficeBouserList: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation
String
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeBouserListApiKey

list_api_key backoffice_bouser

Retrieve backoffice user API keys.


/0.0.1/backoffice/bousers/{id}/api_keys/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bousers/{id}/api_keys/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBouserApi;

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

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | 
        BoUserAPIKeyReferenceCollectionPayload payload = ; // BoUserAPIKeyReferenceCollectionPayload | A backoffice user API key reference collection payload
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_userapi_key_reference_collection result = apiInstance.backofficeBouserListApiKey(id, payload, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserListApiKey");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBouserApi;

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | 
        BoUserAPIKeyReferenceCollectionPayload payload = ; // BoUserAPIKeyReferenceCollectionPayload | A backoffice user API key reference collection payload
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_userapi_key_reference_collection result = apiInstance.backofficeBouserListApiKey(id, payload, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserListApiKey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // 
BoUserAPIKeyReferenceCollectionPayload *payload = ; // A backoffice user API key reference collection payload
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// list_api_key backoffice_bouser
[apiInstance backofficeBouserListApiKeyWith:id
    payload:payload
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(Bo_userapi_key_reference_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBouserApi()

var id = id_example; // {String} 

var payload = ; // {BoUserAPIKeyReferenceCollectionPayload} A backoffice user API key reference collection payload

var opts = { 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeBouserListApiKey(id, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBouserListApiKeyExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBouserApi();
            var id = id_example;  // String | 
            var payload = new BoUserAPIKeyReferenceCollectionPayload(); // BoUserAPIKeyReferenceCollectionPayload | A backoffice user API key reference collection payload
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // list_api_key backoffice_bouser
                Bo_userapi_key_reference_collection result = apiInstance.backofficeBouserListApiKey(id, payload, organisation, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBouserApi.backofficeBouserListApiKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBouserApi();
$id = id_example; // String | 
$payload = ; // BoUserAPIKeyReferenceCollectionPayload | A backoffice user API key reference collection payload
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->backofficeBouserListApiKey($id, $payload, $organisation, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBouserApi->backofficeBouserListApiKey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBouserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBouserApi->new();
my $id = id_example; # String | 
my $payload = WWW::SwaggerClient::Object::BoUserAPIKeyReferenceCollectionPayload->new(); # BoUserAPIKeyReferenceCollectionPayload | A backoffice user API key reference collection payload
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->backofficeBouserListApiKey(id => $id, payload => $payload, organisation => $organisation, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBouserApi->backofficeBouserListApiKey: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBouserApi()
id = id_example # String | 
payload =  # BoUserAPIKeyReferenceCollectionPayload | A backoffice user API key reference collection payload
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # list_api_key backoffice_bouser
    api_response = api_instance.backoffice_bouser_list_api_key(id, payload, organisation=organisation, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBouserApi->backofficeBouserListApiKey: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required
Header parameters
Name Description
Organisation
String
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBouserListMembership

list_membership backoffice_bouser

List membership


/0.0.1/backoffice/bousers/{id}/membership

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bousers/{id}/membership"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBouserApi;

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

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | Backoffice user ID
        OrganisationMembershipCollectionPayload payload = ; // OrganisationMembershipCollectionPayload | A backoffice organisation membership collection payload
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Organisation_membership_collection result = apiInstance.backofficeBouserListMembership(id, payload, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserListMembership");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBouserApi;

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | Backoffice user ID
        OrganisationMembershipCollectionPayload payload = ; // OrganisationMembershipCollectionPayload | A backoffice organisation membership collection payload
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Organisation_membership_collection result = apiInstance.backofficeBouserListMembership(id, payload, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserListMembership");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Backoffice user ID
OrganisationMembershipCollectionPayload *payload = ; // A backoffice organisation membership collection payload
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// list_membership backoffice_bouser
[apiInstance backofficeBouserListMembershipWith:id
    payload:payload
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(Organisation_membership_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBouserApi()

var id = id_example; // {String} Backoffice user ID

var payload = ; // {OrganisationMembershipCollectionPayload} A backoffice organisation membership collection payload

var opts = { 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeBouserListMembership(id, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBouserListMembershipExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBouserApi();
            var id = id_example;  // String | Backoffice user ID
            var payload = new OrganisationMembershipCollectionPayload(); // OrganisationMembershipCollectionPayload | A backoffice organisation membership collection payload
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // list_membership backoffice_bouser
                Organisation_membership_collection result = apiInstance.backofficeBouserListMembership(id, payload, organisation, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBouserApi.backofficeBouserListMembership: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBouserApi();
$id = id_example; // String | Backoffice user ID
$payload = ; // OrganisationMembershipCollectionPayload | A backoffice organisation membership collection payload
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->backofficeBouserListMembership($id, $payload, $organisation, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBouserApi->backofficeBouserListMembership: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBouserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBouserApi->new();
my $id = id_example; # String | Backoffice user ID
my $payload = WWW::SwaggerClient::Object::OrganisationMembershipCollectionPayload->new(); # OrganisationMembershipCollectionPayload | A backoffice organisation membership collection payload
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->backofficeBouserListMembership(id => $id, payload => $payload, organisation => $organisation, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBouserApi->backofficeBouserListMembership: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBouserApi()
id = id_example # String | Backoffice user ID
payload =  # OrganisationMembershipCollectionPayload | A backoffice organisation membership collection payload
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # list_membership backoffice_bouser
    api_response = api_instance.backoffice_bouser_list_membership(id, payload, organisation=organisation, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBouserApi->backofficeBouserListMembership: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Backoffice user ID
Required
Header parameters
Name Description
Organisation
String
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBouserListPushSubscription

list_push_subscription backoffice_bouser

Retrieve backoffice user push subscriotions.


/0.0.1/backoffice/bousers/{id}/push_subscriptions/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bousers/{id}/push_subscriptions/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBouserApi;

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

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | 
        BoUserPushSubscriptionCollectionPayload payload = ; // BoUserPushSubscriptionCollectionPayload | A backoffice user push subscription collection payload
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user_push_subscription_collection result = apiInstance.backofficeBouserListPushSubscription(id, payload, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserListPushSubscription");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBouserApi;

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | 
        BoUserPushSubscriptionCollectionPayload payload = ; // BoUserPushSubscriptionCollectionPayload | A backoffice user push subscription collection payload
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user_push_subscription_collection result = apiInstance.backofficeBouserListPushSubscription(id, payload, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserListPushSubscription");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // 
BoUserPushSubscriptionCollectionPayload *payload = ; // A backoffice user push subscription collection payload
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// list_push_subscription backoffice_bouser
[apiInstance backofficeBouserListPushSubscriptionWith:id
    payload:payload
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(Bo_user_push_subscription_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBouserApi()

var id = id_example; // {String} 

var payload = ; // {BoUserPushSubscriptionCollectionPayload} A backoffice user push subscription collection payload

var opts = { 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeBouserListPushSubscription(id, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBouserListPushSubscriptionExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBouserApi();
            var id = id_example;  // String | 
            var payload = new BoUserPushSubscriptionCollectionPayload(); // BoUserPushSubscriptionCollectionPayload | A backoffice user push subscription collection payload
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // list_push_subscription backoffice_bouser
                Bo_user_push_subscription_collection result = apiInstance.backofficeBouserListPushSubscription(id, payload, organisation, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBouserApi.backofficeBouserListPushSubscription: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBouserApi();
$id = id_example; // String | 
$payload = ; // BoUserPushSubscriptionCollectionPayload | A backoffice user push subscription collection payload
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->backofficeBouserListPushSubscription($id, $payload, $organisation, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBouserApi->backofficeBouserListPushSubscription: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBouserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBouserApi->new();
my $id = id_example; # String | 
my $payload = WWW::SwaggerClient::Object::BoUserPushSubscriptionCollectionPayload->new(); # BoUserPushSubscriptionCollectionPayload | A backoffice user push subscription collection payload
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->backofficeBouserListPushSubscription(id => $id, payload => $payload, organisation => $organisation, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBouserApi->backofficeBouserListPushSubscription: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBouserApi()
id = id_example # String | 
payload =  # BoUserPushSubscriptionCollectionPayload | A backoffice user push subscription collection payload
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # list_push_subscription backoffice_bouser
    api_response = api_instance.backoffice_bouser_list_push_subscription(id, payload, organisation=organisation, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBouserApi->backofficeBouserListPushSubscription: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required
Header parameters
Name Description
Organisation
String
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBouserMe

me backoffice_bouser

Retrieve current backoffice user.


/0.0.1/backoffice/bousers/me

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bousers/me"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBouserApi;

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

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user result = apiInstance.backofficeBouserMe(organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserMe");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBouserApi;

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user result = apiInstance.backofficeBouserMe(organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserMe");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// me backoffice_bouser
[apiInstance backofficeBouserMeWith:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(Bo_user output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBouserApi()

var opts = { 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeBouserMe(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBouserMeExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBouserApi();
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // me backoffice_bouser
                Bo_user result = apiInstance.backofficeBouserMe(organisation, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBouserApi.backofficeBouserMe: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBouserApi();
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->backofficeBouserMe($organisation, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBouserApi->backofficeBouserMe: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBouserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBouserApi->new();
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->backofficeBouserMe(organisation => $organisation, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBouserApi->backofficeBouserMe: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBouserApi()
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # me backoffice_bouser
    api_response = api_instance.backoffice_bouser_me(organisation=organisation, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBouserApi->backofficeBouserMe: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation
String
X-Forwarded-For
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBouserRequestUsernameChange

request_username_change backoffice_bouser

Request a user name change.


/0.0.1/backoffice/bousers/{id}/username_changes

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bousers/{id}/username_changes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBouserApi;

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

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | Backoffice user ID
        RequestUsernameChangeRequestPayload payload = ; // RequestUsernameChangeRequestPayload | A backoffice username change request payload
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            apiInstance.backofficeBouserRequestUsernameChange(id, payload, organisation, xForwardedFor);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserRequestUsernameChange");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBouserApi;

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | Backoffice user ID
        RequestUsernameChangeRequestPayload payload = ; // RequestUsernameChangeRequestPayload | A backoffice username change request payload
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            apiInstance.backofficeBouserRequestUsernameChange(id, payload, organisation, xForwardedFor);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserRequestUsernameChange");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Backoffice user ID
RequestUsernameChangeRequestPayload *payload = ; // A backoffice username change request payload
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// request_username_change backoffice_bouser
[apiInstance backofficeBouserRequestUsernameChangeWith:id
    payload:payload
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBouserApi()

var id = id_example; // {String} Backoffice user ID

var payload = ; // {RequestUsernameChangeRequestPayload} A backoffice username change request payload

var opts = { 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeBouserRequestUsernameChange(id, payload, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBouserRequestUsernameChangeExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBouserApi();
            var id = id_example;  // String | Backoffice user ID
            var payload = new RequestUsernameChangeRequestPayload(); // RequestUsernameChangeRequestPayload | A backoffice username change request payload
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // request_username_change backoffice_bouser
                apiInstance.backofficeBouserRequestUsernameChange(id, payload, organisation, xForwardedFor);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBouserApi.backofficeBouserRequestUsernameChange: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBouserApi();
$id = id_example; // String | Backoffice user ID
$payload = ; // RequestUsernameChangeRequestPayload | A backoffice username change request payload
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $api_instance->backofficeBouserRequestUsernameChange($id, $payload, $organisation, $xForwardedFor);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBouserApi->backofficeBouserRequestUsernameChange: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBouserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBouserApi->new();
my $id = id_example; # String | Backoffice user ID
my $payload = WWW::SwaggerClient::Object::RequestUsernameChangeRequestPayload->new(); # RequestUsernameChangeRequestPayload | A backoffice username change request payload
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    $api_instance->backofficeBouserRequestUsernameChange(id => $id, payload => $payload, organisation => $organisation, xForwardedFor => $xForwardedFor);
};
if ($@) {
    warn "Exception when calling BackofficeBouserApi->backofficeBouserRequestUsernameChange: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBouserApi()
id = id_example # String | Backoffice user ID
payload =  # RequestUsernameChangeRequestPayload | A backoffice username change request payload
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # request_username_change backoffice_bouser
    api_instance.backoffice_bouser_request_username_change(id, payload, organisation=organisation, xForwardedFor=xForwardedFor)
except ApiException as e:
    print("Exception when calling BackofficeBouserApi->backofficeBouserRequestUsernameChange: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Backoffice user ID
Required
Header parameters
Name Description
Organisation
String
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBouserShow

show backoffice_bouser

Retrieve backoffice user with given id.


/0.0.1/backoffice/bousers/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bousers/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBouserApi;

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

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | Backoffice user ID
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user result = apiInstance.backofficeBouserShow(id, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBouserApi;

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | Backoffice user ID
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user result = apiInstance.backofficeBouserShow(id, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Backoffice user ID
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// show backoffice_bouser
[apiInstance backofficeBouserShowWith:id
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(Bo_user output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBouserApi()

var id = id_example; // {String} Backoffice user ID

var opts = { 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeBouserShow(id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBouserShowExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBouserApi();
            var id = id_example;  // String | Backoffice user ID
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // show backoffice_bouser
                Bo_user result = apiInstance.backofficeBouserShow(id, organisation, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBouserApi.backofficeBouserShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBouserApi();
$id = id_example; // String | Backoffice user ID
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->backofficeBouserShow($id, $organisation, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBouserApi->backofficeBouserShow: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBouserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBouserApi->new();
my $id = id_example; # String | Backoffice user ID
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBouserApi()
id = id_example # String | Backoffice user ID
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # show backoffice_bouser
    api_response = api_instance.backoffice_bouser_show(id, organisation=organisation, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBouserApi->backofficeBouserShow: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Backoffice user ID
Required
Header parameters
Name Description
Organisation
String
X-Forwarded-For
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBouserShowMemberSettings

show_member_settings backoffice_bouser

Get backoffice user member settings


/0.0.1/backoffice/bousers/{id}/member_settings

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bousers/{id}/member_settings"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBouserApi;

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

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | Backoffice user ID
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Organisation_member_settings result = apiInstance.backofficeBouserShowMemberSettings(id, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserShowMemberSettings");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBouserApi;

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | Backoffice user ID
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Organisation_member_settings result = apiInstance.backofficeBouserShowMemberSettings(id, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserShowMemberSettings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Backoffice user ID
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// show_member_settings backoffice_bouser
[apiInstance backofficeBouserShowMemberSettingsWith:id
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(Organisation_member_settings output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBouserApi()

var id = id_example; // {String} Backoffice user ID

var opts = { 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeBouserShowMemberSettings(id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBouserShowMemberSettingsExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBouserApi();
            var id = id_example;  // String | Backoffice user ID
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // show_member_settings backoffice_bouser
                Organisation_member_settings result = apiInstance.backofficeBouserShowMemberSettings(id, organisation, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBouserApi.backofficeBouserShowMemberSettings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBouserApi();
$id = id_example; // String | Backoffice user ID
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->backofficeBouserShowMemberSettings($id, $organisation, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBouserApi->backofficeBouserShowMemberSettings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBouserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBouserApi->new();
my $id = id_example; # String | Backoffice user ID
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBouserApi()
id = id_example # String | Backoffice user ID
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # show_member_settings backoffice_bouser
    api_response = api_instance.backoffice_bouser_show_member_settings(id, organisation=organisation, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBouserApi->backofficeBouserShowMemberSettings: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Backoffice user ID
Required
Header parameters
Name Description
Organisation
String
X-Forwarded-For
String

Responses

Status: 200 - OK

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBouserShowUsernameChange

show_username_change backoffice_bouser

Retrieve backoffice user invite with given code.


/0.0.1/backoffice/bousers/username_changes/{code}

Usage and SDK Samples

curl -X GET "https://api.quriobot.com/0.0.1/backoffice/bousers/username_changes/{code}?id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBouserApi;

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

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        
        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String code = code_example; // String | Backoffice user username change code
        String id = id_example; // String | Backoffice user ID
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user_username_change result = apiInstance.backofficeBouserShowUsernameChange(code, id, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserShowUsernameChange");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBouserApi;

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String code = code_example; // String | Backoffice user username change code
        String id = id_example; // String | Backoffice user ID
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user_username_change result = apiInstance.backofficeBouserShowUsernameChange(code, id, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserShowUsernameChange");
            e.printStackTrace();
        }
    }
}
String *code = code_example; // Backoffice user username change code
String *id = id_example; // Backoffice user ID (optional)
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// show_username_change backoffice_bouser
[apiInstance backofficeBouserShowUsernameChangeWith:code
    id:id
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(Bo_user_username_change output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.BackofficeBouserApi()

var code = code_example; // {String} Backoffice user username change code

var opts = { 
  'id': id_example, // {String} Backoffice user ID
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeBouserShowUsernameChange(code, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBouserShowUsernameChangeExample
    {
        public void main()
        {
            
            var apiInstance = new BackofficeBouserApi();
            var code = code_example;  // String | Backoffice user username change code
            var id = id_example;  // String | Backoffice user ID (optional) 
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // show_username_change backoffice_bouser
                Bo_user_username_change result = apiInstance.backofficeBouserShowUsernameChange(code, id, organisation, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBouserApi.backofficeBouserShowUsernameChange: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BackofficeBouserApi();
$code = code_example; // String | Backoffice user username change code
$id = id_example; // String | Backoffice user ID
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->backofficeBouserShowUsernameChange($code, $id, $organisation, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBouserApi->backofficeBouserShowUsernameChange: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBouserApi;

my $api_instance = WWW::SwaggerClient::BackofficeBouserApi->new();
my $code = code_example; # String | Backoffice user username change code
my $id = id_example; # String | Backoffice user ID
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->backofficeBouserShowUsernameChange(code => $code, id => $id, organisation => $organisation, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBouserApi->backofficeBouserShowUsernameChange: $@\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.BackofficeBouserApi()
code = code_example # String | Backoffice user username change code
id = id_example # String | Backoffice user ID (optional)
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # show_username_change backoffice_bouser
    api_response = api_instance.backoffice_bouser_show_username_change(code, id=id, organisation=organisation, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBouserApi->backofficeBouserShowUsernameChange: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
Backoffice user username change code
Required
Header parameters
Name Description
Organisation
String
X-Forwarded-For
String
Query parameters
Name Description
id
String
Backoffice user ID

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 404 - Not Found


backofficeBouserUpdate

update backoffice_bouser

Change backoffice user


/0.0.1/backoffice/bousers/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bousers/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBouserApi;

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

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | Backoffice user ID
        BoUserUpdatePayload payload = ; // BoUserUpdatePayload | A backoffice user payload
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user result = apiInstance.backofficeBouserUpdate(id, payload, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBouserApi;

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | Backoffice user ID
        BoUserUpdatePayload payload = ; // BoUserUpdatePayload | A backoffice user payload
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user result = apiInstance.backofficeBouserUpdate(id, payload, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Backoffice user ID
BoUserUpdatePayload *payload = ; // A backoffice user payload
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// update backoffice_bouser
[apiInstance backofficeBouserUpdateWith:id
    payload:payload
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(Bo_user output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBouserApi()

var id = id_example; // {String} Backoffice user ID

var payload = ; // {BoUserUpdatePayload} A backoffice user payload

var opts = { 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeBouserUpdate(id, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBouserUpdateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBouserApi();
            var id = id_example;  // String | Backoffice user ID
            var payload = new BoUserUpdatePayload(); // BoUserUpdatePayload | A backoffice user payload
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // update backoffice_bouser
                Bo_user result = apiInstance.backofficeBouserUpdate(id, payload, organisation, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBouserApi.backofficeBouserUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBouserApi();
$id = id_example; // String | Backoffice user ID
$payload = ; // BoUserUpdatePayload | A backoffice user payload
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->backofficeBouserUpdate($id, $payload, $organisation, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBouserApi->backofficeBouserUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBouserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBouserApi->new();
my $id = id_example; # String | Backoffice user ID
my $payload = WWW::SwaggerClient::Object::BoUserUpdatePayload->new(); # BoUserUpdatePayload | A backoffice user payload
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->backofficeBouserUpdate(id => $id, payload => $payload, organisation => $organisation, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeBouserApi->backofficeBouserUpdate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBouserApi()
id = id_example # String | Backoffice user ID
payload =  # BoUserUpdatePayload | A backoffice user payload
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # update backoffice_bouser
    api_response = api_instance.backoffice_bouser_update(id, payload, organisation=organisation, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeBouserApi->backofficeBouserUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Backoffice user ID
Required
Header parameters
Name Description
Organisation
String
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBouserUpdateMemberSettings

update_member_settings backoffice_bouser

Update backoffice user member settings


/0.0.1/backoffice/bousers/{id}/member_settings

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bousers/{id}/member_settings"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBouserApi;

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

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | Backoffice user ID
        OrganisationMemberSettingsPayload payload = ; // OrganisationMemberSettingsPayload | Backoffice user member settings payload
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            apiInstance.backofficeBouserUpdateMemberSettings(id, payload, organisation, xForwardedFor);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserUpdateMemberSettings");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBouserApi;

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | Backoffice user ID
        OrganisationMemberSettingsPayload payload = ; // OrganisationMemberSettingsPayload | Backoffice user member settings payload
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            apiInstance.backofficeBouserUpdateMemberSettings(id, payload, organisation, xForwardedFor);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserUpdateMemberSettings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Backoffice user ID
OrganisationMemberSettingsPayload *payload = ; // Backoffice user member settings payload
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// update_member_settings backoffice_bouser
[apiInstance backofficeBouserUpdateMemberSettingsWith:id
    payload:payload
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBouserApi()

var id = id_example; // {String} Backoffice user ID

var payload = ; // {OrganisationMemberSettingsPayload} Backoffice user member settings payload

var opts = { 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeBouserUpdateMemberSettings(id, payload, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBouserUpdateMemberSettingsExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBouserApi();
            var id = id_example;  // String | Backoffice user ID
            var payload = new OrganisationMemberSettingsPayload(); // OrganisationMemberSettingsPayload | Backoffice user member settings payload
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // update_member_settings backoffice_bouser
                apiInstance.backofficeBouserUpdateMemberSettings(id, payload, organisation, xForwardedFor);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBouserApi.backofficeBouserUpdateMemberSettings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBouserApi();
$id = id_example; // String | Backoffice user ID
$payload = ; // OrganisationMemberSettingsPayload | Backoffice user member settings payload
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $api_instance->backofficeBouserUpdateMemberSettings($id, $payload, $organisation, $xForwardedFor);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBouserApi->backofficeBouserUpdateMemberSettings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBouserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBouserApi->new();
my $id = id_example; # String | Backoffice user ID
my $payload = WWW::SwaggerClient::Object::OrganisationMemberSettingsPayload->new(); # OrganisationMemberSettingsPayload | Backoffice user member settings payload
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    $api_instance->backofficeBouserUpdateMemberSettings(id => $id, payload => $payload, organisation => $organisation, xForwardedFor => $xForwardedFor);
};
if ($@) {
    warn "Exception when calling BackofficeBouserApi->backofficeBouserUpdateMemberSettings: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBouserApi()
id = id_example # String | Backoffice user ID
payload =  # OrganisationMemberSettingsPayload | Backoffice user member settings payload
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # update_member_settings backoffice_bouser
    api_instance.backoffice_bouser_update_member_settings(id, payload, organisation=organisation, xForwardedFor=xForwardedFor)
except ApiException as e:
    print("Exception when calling BackofficeBouserApi->backofficeBouserUpdateMemberSettings: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Backoffice user ID
Required
Header parameters
Name Description
Organisation
String
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeBouserUpdatePushSubscription

update_push_subscription backoffice_bouser

Update backoffice user push subscription


/0.0.1/backoffice/bousers/{id}/push_subscriptions/{subscription_id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bousers/{id}/push_subscriptions/{subscription_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeBouserApi;

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

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | Backoffice user ID
        String subscriptionId = subscriptionId_example; // String | Backoffice user push subscription ID
        BoUserPushSubscriptionPayload payload = ; // BoUserPushSubscriptionPayload | Backoffice user push subscription payload
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            apiInstance.backofficeBouserUpdatePushSubscription(id, subscriptionId, payload, organisation, xForwardedFor);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserUpdatePushSubscription");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeBouserApi;

public class BackofficeBouserApiExample {

    public static void main(String[] args) {
        BackofficeBouserApi apiInstance = new BackofficeBouserApi();
        String id = id_example; // String | Backoffice user ID
        String subscriptionId = subscriptionId_example; // String | Backoffice user push subscription ID
        BoUserPushSubscriptionPayload payload = ; // BoUserPushSubscriptionPayload | Backoffice user push subscription payload
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            apiInstance.backofficeBouserUpdatePushSubscription(id, subscriptionId, payload, organisation, xForwardedFor);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeBouserApi#backofficeBouserUpdatePushSubscription");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Backoffice user ID
String *subscriptionId = subscriptionId_example; // Backoffice user push subscription ID
BoUserPushSubscriptionPayload *payload = ; // Backoffice user push subscription payload
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// update_push_subscription backoffice_bouser
[apiInstance backofficeBouserUpdatePushSubscriptionWith:id
    subscriptionId:subscriptionId
    payload:payload
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeBouserApi()

var id = id_example; // {String} Backoffice user ID

var subscriptionId = subscriptionId_example; // {String} Backoffice user push subscription ID

var payload = ; // {BoUserPushSubscriptionPayload} Backoffice user push subscription payload

var opts = { 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeBouserUpdatePushSubscription(id, subscriptionId, payload, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeBouserUpdatePushSubscriptionExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeBouserApi();
            var id = id_example;  // String | Backoffice user ID
            var subscriptionId = subscriptionId_example;  // String | Backoffice user push subscription ID
            var payload = new BoUserPushSubscriptionPayload(); // BoUserPushSubscriptionPayload | Backoffice user push subscription payload
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // update_push_subscription backoffice_bouser
                apiInstance.backofficeBouserUpdatePushSubscription(id, subscriptionId, payload, organisation, xForwardedFor);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeBouserApi.backofficeBouserUpdatePushSubscription: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeBouserApi();
$id = id_example; // String | Backoffice user ID
$subscriptionId = subscriptionId_example; // String | Backoffice user push subscription ID
$payload = ; // BoUserPushSubscriptionPayload | Backoffice user push subscription payload
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $api_instance->backofficeBouserUpdatePushSubscription($id, $subscriptionId, $payload, $organisation, $xForwardedFor);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeBouserApi->backofficeBouserUpdatePushSubscription: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeBouserApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeBouserApi->new();
my $id = id_example; # String | Backoffice user ID
my $subscriptionId = subscriptionId_example; # String | Backoffice user push subscription ID
my $payload = WWW::SwaggerClient::Object::BoUserPushSubscriptionPayload->new(); # BoUserPushSubscriptionPayload | Backoffice user push subscription payload
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    $api_instance->backofficeBouserUpdatePushSubscription(id => $id, subscriptionId => $subscriptionId, payload => $payload, organisation => $organisation, xForwardedFor => $xForwardedFor);
};
if ($@) {
    warn "Exception when calling BackofficeBouserApi->backofficeBouserUpdatePushSubscription: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeBouserApi()
id = id_example # String | Backoffice user ID
subscriptionId = subscriptionId_example # String | Backoffice user push subscription ID
payload =  # BoUserPushSubscriptionPayload | Backoffice user push subscription payload
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # update_push_subscription backoffice_bouser
    api_instance.backoffice_bouser_update_push_subscription(id, subscriptionId, payload, organisation=organisation, xForwardedFor=xForwardedFor)
except ApiException as e:
    print("Exception when calling BackofficeBouserApi->backofficeBouserUpdatePushSubscription: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Backoffice user ID
Required
subscription_id*
String
Backoffice user push subscription ID
Required
Header parameters
Name Description
Organisation
String
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


BackofficeContact

backofficeContactCreate

create backoffice_contact

Create contact


/0.0.1/backoffice/contacts

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/contacts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeContactApi;

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

public class BackofficeContactApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeContactApi apiInstance = new BackofficeContactApi();
        String organisation = organisation_example; // String | 
        ChatContactPayload payload = ; // ChatContactPayload | Chat contact payload
        String bot = bot_example; // String | 
        try {
            Chat_contact result = apiInstance.backofficeContactCreate(organisation, payload, bot);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeContactApi#backofficeContactCreate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeContactApi;

public class BackofficeContactApiExample {

    public static void main(String[] args) {
        BackofficeContactApi apiInstance = new BackofficeContactApi();
        String organisation = organisation_example; // String | 
        ChatContactPayload payload = ; // ChatContactPayload | Chat contact payload
        String bot = bot_example; // String | 
        try {
            Chat_contact result = apiInstance.backofficeContactCreate(organisation, payload, bot);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeContactApi#backofficeContactCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
ChatContactPayload *payload = ; // Chat contact payload
String *bot = bot_example; //  (optional)

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

// create backoffice_contact
[apiInstance backofficeContactCreateWith:organisation
    payload:payload
    bot:bot
              completionHandler: ^(Chat_contact output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeContactApi()

var organisation = organisation_example; // {String} 

var payload = ; // {ChatContactPayload} Chat contact payload

var opts = { 
  'bot': bot_example // {String} 
};
api.backofficeContactCreate(organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeContactCreateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeContactApi();
            var organisation = organisation_example;  // String | 
            var payload = new ChatContactPayload(); // ChatContactPayload | Chat contact payload
            var bot = bot_example;  // String |  (optional) 

            try
            {
                // create backoffice_contact
                Chat_contact result = apiInstance.backofficeContactCreate(organisation, payload, bot);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeContactApi.backofficeContactCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeContactApi();
$organisation = organisation_example; // String | 
$payload = ; // ChatContactPayload | Chat contact payload
$bot = bot_example; // String | 

try {
    $result = $api_instance->backofficeContactCreate($organisation, $payload, $bot);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeContactApi->backofficeContactCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeContactApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeContactApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::ChatContactPayload->new(); # ChatContactPayload | Chat contact payload
my $bot = bot_example; # String | 

eval { 
    my $result = $api_instance->backofficeContactCreate(organisation => $organisation, payload => $payload, bot => $bot);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeContactApi->backofficeContactCreate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeContactApi()
organisation = organisation_example # String | 
payload =  # ChatContactPayload | Chat contact payload
bot = bot_example # String |  (optional)

try: 
    # create backoffice_contact
    api_response = api_instance.backoffice_contact_create(organisation, payload, bot=bot)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeContactApi->backofficeContactCreate: %s\n" % e)

Parameters

Header parameters
Name Description
Bot
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeContactDelete

delete backoffice_contact


/0.0.1/backoffice/contacts

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/contacts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeContactApi;

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

public class BackofficeContactApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeContactApi apiInstance = new BackofficeContactApi();
        String organisation = organisation_example; // String | 
        ChatContactDeletePayload payload = ; // ChatContactDeletePayload | Chat contact delete payload
        try {
            apiInstance.backofficeContactDelete(organisation, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeContactApi#backofficeContactDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeContactApi;

public class BackofficeContactApiExample {

    public static void main(String[] args) {
        BackofficeContactApi apiInstance = new BackofficeContactApi();
        String organisation = organisation_example; // String | 
        ChatContactDeletePayload payload = ; // ChatContactDeletePayload | Chat contact delete payload
        try {
            apiInstance.backofficeContactDelete(organisation, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeContactApi#backofficeContactDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
ChatContactDeletePayload *payload = ; // Chat contact delete payload

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

// delete backoffice_contact
[apiInstance backofficeContactDeleteWith:organisation
    payload:payload
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeContactApi()

var organisation = organisation_example; // {String} 

var payload = ; // {ChatContactDeletePayload} Chat contact delete payload

api.backofficeContactDelete(organisation, payload).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeContactDeleteExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeContactApi();
            var organisation = organisation_example;  // String | 
            var payload = new ChatContactDeletePayload(); // ChatContactDeletePayload | Chat contact delete payload

            try
            {
                // delete backoffice_contact
                apiInstance.backofficeContactDelete(organisation, payload);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeContactApi.backofficeContactDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeContactApi();
$organisation = organisation_example; // String | 
$payload = ; // ChatContactDeletePayload | Chat contact delete payload

try {
    $api_instance->backofficeContactDelete($organisation, $payload);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeContactApi->backofficeContactDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeContactApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeContactApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::ChatContactDeletePayload->new(); # ChatContactDeletePayload | Chat contact delete payload

eval { 
    $api_instance->backofficeContactDelete(organisation => $organisation, payload => $payload);
};
if ($@) {
    warn "Exception when calling BackofficeContactApi->backofficeContactDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeContactApi()
organisation = organisation_example # String | 
payload =  # ChatContactDeletePayload | Chat contact delete payload

try: 
    # delete backoffice_contact
    api_instance.backoffice_contact_delete(organisation, payload)
except ApiException as e:
    print("Exception when calling BackofficeContactApi->backofficeContactDelete: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeContactDownload

download backoffice_contact

Download contacts.


/0.0.1/backoffice/contacts/download

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/contacts/download"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeContactApi;

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

public class BackofficeContactApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeContactApi apiInstance = new BackofficeContactApi();
        String organisation = organisation_example; // String | 
        ChatContactCollectionPayload payload = ; // ChatContactCollectionPayload | Chat contact collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Download result = apiInstance.backofficeContactDownload(organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeContactApi#backofficeContactDownload");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeContactApi;

public class BackofficeContactApiExample {

    public static void main(String[] args) {
        BackofficeContactApi apiInstance = new BackofficeContactApi();
        String organisation = organisation_example; // String | 
        ChatContactCollectionPayload payload = ; // ChatContactCollectionPayload | Chat contact collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Download result = apiInstance.backofficeContactDownload(organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeContactApi#backofficeContactDownload");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
ChatContactCollectionPayload *payload = ; // Chat contact collection payload
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// download backoffice_contact
[apiInstance backofficeContactDownloadWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(Download output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeContactApi()

var organisation = organisation_example; // {String} 

var payload = ; // {ChatContactCollectionPayload} Chat contact collection payload

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeContactDownload(organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeContactDownloadExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeContactApi();
            var organisation = organisation_example;  // String | 
            var payload = new ChatContactCollectionPayload(); // ChatContactCollectionPayload | Chat contact collection payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // download backoffice_contact
                Download result = apiInstance.backofficeContactDownload(organisation, payload, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeContactApi.backofficeContactDownload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeContactApi();
$organisation = organisation_example; // String | 
$payload = ; // ChatContactCollectionPayload | Chat contact collection payload
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeContactDownload($organisation, $payload, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeContactApi->backofficeContactDownload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeContactApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeContactApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::ChatContactCollectionPayload->new(); # ChatContactCollectionPayload | Chat contact collection payload
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeContactDownload(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeContactApi->backofficeContactDownload: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeContactApi()
organisation = organisation_example # String | 
payload =  # ChatContactCollectionPayload | Chat contact collection payload
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # download backoffice_contact
    api_response = api_instance.backoffice_contact_download(organisation, payload, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeContactApi->backofficeContactDownload: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeContactList

list backoffice_contact

Retrieve all contacts.


/0.0.1/backoffice/contacts/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/contacts/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeContactApi;

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

public class BackofficeContactApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeContactApi apiInstance = new BackofficeContactApi();
        String organisation = organisation_example; // String | 
        ChatContactCollectionPayload payload = ; // ChatContactCollectionPayload | Chat contact collection payload
        try {
            Chat_contact_collection result = apiInstance.backofficeContactList(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeContactApi#backofficeContactList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeContactApi;

public class BackofficeContactApiExample {

    public static void main(String[] args) {
        BackofficeContactApi apiInstance = new BackofficeContactApi();
        String organisation = organisation_example; // String | 
        ChatContactCollectionPayload payload = ; // ChatContactCollectionPayload | Chat contact collection payload
        try {
            Chat_contact_collection result = apiInstance.backofficeContactList(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeContactApi#backofficeContactList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
ChatContactCollectionPayload *payload = ; // Chat contact collection payload

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

// list backoffice_contact
[apiInstance backofficeContactListWith:organisation
    payload:payload
              completionHandler: ^(Chat_contact_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeContactApi()

var organisation = organisation_example; // {String} 

var payload = ; // {ChatContactCollectionPayload} Chat contact collection payload

api.backofficeContactList(organisation, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeContactListExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeContactApi();
            var organisation = organisation_example;  // String | 
            var payload = new ChatContactCollectionPayload(); // ChatContactCollectionPayload | Chat contact collection payload

            try
            {
                // list backoffice_contact
                Chat_contact_collection result = apiInstance.backofficeContactList(organisation, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeContactApi.backofficeContactList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeContactApi();
$organisation = organisation_example; // String | 
$payload = ; // ChatContactCollectionPayload | Chat contact collection payload

try {
    $result = $api_instance->backofficeContactList($organisation, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeContactApi->backofficeContactList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeContactApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeContactApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::ChatContactCollectionPayload->new(); # ChatContactCollectionPayload | Chat contact collection payload

eval { 
    my $result = $api_instance->backofficeContactList(organisation => $organisation, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeContactApi->backofficeContactList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeContactApi()
organisation = organisation_example # String | 
payload =  # ChatContactCollectionPayload | Chat contact collection payload

try: 
    # list backoffice_contact
    api_response = api_instance.backoffice_contact_list(organisation, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeContactApi->backofficeContactList: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeContactShow

show backoffice_contact

Get contact


/0.0.1/backoffice/contacts/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/contacts/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeContactApi;

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

public class BackofficeContactApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeContactApi apiInstance = new BackofficeContactApi();
        String id = id_example; // String | Contact ID
        String organisation = organisation_example; // String | 
        try {
            Chat_contact result = apiInstance.backofficeContactShow(id, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeContactApi#backofficeContactShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeContactApi;

public class BackofficeContactApiExample {

    public static void main(String[] args) {
        BackofficeContactApi apiInstance = new BackofficeContactApi();
        String id = id_example; // String | Contact ID
        String organisation = organisation_example; // String | 
        try {
            Chat_contact result = apiInstance.backofficeContactShow(id, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeContactApi#backofficeContactShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Contact ID
String *organisation = organisation_example; // 

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

// show backoffice_contact
[apiInstance backofficeContactShowWith:id
    organisation:organisation
              completionHandler: ^(Chat_contact output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeContactApi()

var id = id_example; // {String} Contact ID

var organisation = organisation_example; // {String} 

api.backofficeContactShow(id, organisation).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeContactShowExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeContactApi();
            var id = id_example;  // String | Contact ID
            var organisation = organisation_example;  // String | 

            try
            {
                // show backoffice_contact
                Chat_contact result = apiInstance.backofficeContactShow(id, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeContactApi.backofficeContactShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeContactApi();
$id = id_example; // String | Contact ID
$organisation = organisation_example; // String | 

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

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeContactApi->new();
my $id = id_example; # String | Contact ID
my $organisation = organisation_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeContactApi()
id = id_example # String | Contact ID
organisation = organisation_example # String | 

try: 
    # show backoffice_contact
    api_response = api_instance.backoffice_contact_show(id, organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeContactApi->backofficeContactShow: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Contact ID
Required
Header parameters
Name Description
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeContactShowDownload

show_download backoffice_contact

Retrieve contacts download.


/0.0.1/backoffice/contacts/download/{downloadID}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/contacts/download/{downloadID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeContactApi;

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

public class BackofficeContactApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeContactApi apiInstance = new BackofficeContactApi();
        String downloadID = downloadID_example; // String | Download ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Download result = apiInstance.backofficeContactShowDownload(downloadID, organisation, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeContactApi#backofficeContactShowDownload");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeContactApi;

public class BackofficeContactApiExample {

    public static void main(String[] args) {
        BackofficeContactApi apiInstance = new BackofficeContactApi();
        String downloadID = downloadID_example; // String | Download ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Download result = apiInstance.backofficeContactShowDownload(downloadID, organisation, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeContactApi#backofficeContactShowDownload");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *downloadID = downloadID_example; // Download ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// show_download backoffice_contact
[apiInstance backofficeContactShowDownloadWith:downloadID
    organisation:organisation
    acceptLanguage:acceptLanguage
              completionHandler: ^(Download output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeContactApi()

var downloadID = downloadID_example; // {String} Download ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeContactShowDownload(downloadID, organisation, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeContactShowDownloadExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeContactApi();
            var downloadID = downloadID_example;  // String | Download ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // show_download backoffice_contact
                Download result = apiInstance.backofficeContactShowDownload(downloadID, organisation, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeContactApi.backofficeContactShowDownload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeContactApi();
$downloadID = downloadID_example; // String | Download ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeContactShowDownload($downloadID, $organisation, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeContactApi->backofficeContactShowDownload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeContactApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeContactApi->new();
my $downloadID = downloadID_example; # String | Download ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeContactShowDownload(downloadID => $downloadID, organisation => $organisation, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeContactApi->backofficeContactShowDownload: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeContactApi()
downloadID = downloadID_example # String | Download ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # show_download backoffice_contact
    api_response = api_instance.backoffice_contact_show_download(downloadID, organisation, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeContactApi->backofficeContactShowDownload: %s\n" % e)

Parameters

Path parameters
Name Description
downloadID*
String
Download ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeContactUpdate

update backoffice_contact

Change contact


/0.0.1/backoffice/contacts/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/contacts/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeContactApi;

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

public class BackofficeContactApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeContactApi apiInstance = new BackofficeContactApi();
        String id = id_example; // String | Contact ID
        String organisation = organisation_example; // String | 
        ChatContactPayload payload = ; // ChatContactPayload | Chat contact payload
        String bot = bot_example; // String | 
        try {
            Chat_contact result = apiInstance.backofficeContactUpdate(id, organisation, payload, bot);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeContactApi#backofficeContactUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeContactApi;

public class BackofficeContactApiExample {

    public static void main(String[] args) {
        BackofficeContactApi apiInstance = new BackofficeContactApi();
        String id = id_example; // String | Contact ID
        String organisation = organisation_example; // String | 
        ChatContactPayload payload = ; // ChatContactPayload | Chat contact payload
        String bot = bot_example; // String | 
        try {
            Chat_contact result = apiInstance.backofficeContactUpdate(id, organisation, payload, bot);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeContactApi#backofficeContactUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Contact ID
String *organisation = organisation_example; // 
ChatContactPayload *payload = ; // Chat contact payload
String *bot = bot_example; //  (optional)

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

// update backoffice_contact
[apiInstance backofficeContactUpdateWith:id
    organisation:organisation
    payload:payload
    bot:bot
              completionHandler: ^(Chat_contact output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeContactApi()

var id = id_example; // {String} Contact ID

var organisation = organisation_example; // {String} 

var payload = ; // {ChatContactPayload} Chat contact payload

var opts = { 
  'bot': bot_example // {String} 
};
api.backofficeContactUpdate(id, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeContactUpdateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeContactApi();
            var id = id_example;  // String | Contact ID
            var organisation = organisation_example;  // String | 
            var payload = new ChatContactPayload(); // ChatContactPayload | Chat contact payload
            var bot = bot_example;  // String |  (optional) 

            try
            {
                // update backoffice_contact
                Chat_contact result = apiInstance.backofficeContactUpdate(id, organisation, payload, bot);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeContactApi.backofficeContactUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeContactApi();
$id = id_example; // String | Contact ID
$organisation = organisation_example; // String | 
$payload = ; // ChatContactPayload | Chat contact payload
$bot = bot_example; // String | 

try {
    $result = $api_instance->backofficeContactUpdate($id, $organisation, $payload, $bot);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeContactApi->backofficeContactUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeContactApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeContactApi->new();
my $id = id_example; # String | Contact ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::ChatContactPayload->new(); # ChatContactPayload | Chat contact payload
my $bot = bot_example; # String | 

eval { 
    my $result = $api_instance->backofficeContactUpdate(id => $id, organisation => $organisation, payload => $payload, bot => $bot);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeContactApi->backofficeContactUpdate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeContactApi()
id = id_example # String | Contact ID
organisation = organisation_example # String | 
payload =  # ChatContactPayload | Chat contact payload
bot = bot_example # String |  (optional)

try: 
    # update backoffice_contact
    api_response = api_instance.backoffice_contact_update(id, organisation, payload, bot=bot)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeContactApi->backofficeContactUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Contact ID
Required
Header parameters
Name Description
Bot
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


BackofficeEnum

backofficeEnumShow

show backoffice_enum

List enum values


/0.0.1/backoffice/enums/{name}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/enums/{name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeEnumApi;

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

public class BackofficeEnumApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeEnumApi apiInstance = new BackofficeEnumApi();
        String name = name_example; // String | Enum name
        try {
            Enum_value_collection result = apiInstance.backofficeEnumShow(name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeEnumApi#backofficeEnumShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeEnumApi;

public class BackofficeEnumApiExample {

    public static void main(String[] args) {
        BackofficeEnumApi apiInstance = new BackofficeEnumApi();
        String name = name_example; // String | Enum name
        try {
            Enum_value_collection result = apiInstance.backofficeEnumShow(name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeEnumApi#backofficeEnumShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *name = name_example; // Enum name

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

// show backoffice_enum
[apiInstance backofficeEnumShowWith:name
              completionHandler: ^(Enum_value_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeEnumApi()

var name = name_example; // {String} Enum name

api.backofficeEnumShow(name).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeEnumShowExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeEnumApi();
            var name = name_example;  // String | Enum name

            try
            {
                // show backoffice_enum
                Enum_value_collection result = apiInstance.backofficeEnumShow(name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeEnumApi.backofficeEnumShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeEnumApi();
$name = name_example; // String | Enum name

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

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeEnumApi->new();
my $name = name_example; # String | Enum name

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeEnumApi()
name = name_example # String | Enum name

try: 
    # show backoffice_enum
    api_response = api_instance.backoffice_enum_show(name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeEnumApi->backofficeEnumShow: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
Enum name
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


BackofficeIntegration

backofficeIntegrationAuthorize

authorize backoffice_integration

Authorize integration.


/0.0.1/backoffice/integrations/{type}/oauth_callback

Usage and SDK Samples

curl -X GET "https://api.quriobot.com/0.0.1/backoffice/integrations/{type}/oauth_callback"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeIntegrationApi;

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

public class BackofficeIntegrationApiExample {

    public static void main(String[] args) {
        
        BackofficeIntegrationApi apiInstance = new BackofficeIntegrationApi();
        String type = type_example; // String | Integration type
        try {
            apiInstance.backofficeIntegrationAuthorize(type);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeIntegrationApi#backofficeIntegrationAuthorize");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeIntegrationApi;

public class BackofficeIntegrationApiExample {

    public static void main(String[] args) {
        BackofficeIntegrationApi apiInstance = new BackofficeIntegrationApi();
        String type = type_example; // String | Integration type
        try {
            apiInstance.backofficeIntegrationAuthorize(type);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeIntegrationApi#backofficeIntegrationAuthorize");
            e.printStackTrace();
        }
    }
}
String *type = type_example; // Integration type

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

// authorize backoffice_integration
[apiInstance backofficeIntegrationAuthorizeWith:type
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.BackofficeIntegrationApi()

var type = type_example; // {String} Integration type

api.backofficeIntegrationAuthorize(type).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeIntegrationAuthorizeExample
    {
        public void main()
        {
            
            var apiInstance = new BackofficeIntegrationApi();
            var type = type_example;  // String | Integration type

            try
            {
                // authorize backoffice_integration
                apiInstance.backofficeIntegrationAuthorize(type);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeIntegrationApi.backofficeIntegrationAuthorize: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BackofficeIntegrationApi();
$type = type_example; // String | Integration type

try {
    $api_instance->backofficeIntegrationAuthorize($type);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeIntegrationApi->backofficeIntegrationAuthorize: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeIntegrationApi;

my $api_instance = WWW::SwaggerClient::BackofficeIntegrationApi->new();
my $type = type_example; # String | Integration type

eval { 
    $api_instance->backofficeIntegrationAuthorize(type => $type);
};
if ($@) {
    warn "Exception when calling BackofficeIntegrationApi->backofficeIntegrationAuthorize: $@\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.BackofficeIntegrationApi()
type = type_example # String | Integration type

try: 
    # authorize backoffice_integration
    api_instance.backoffice_integration_authorize(type)
except ApiException as e:
    print("Exception when calling BackofficeIntegrationApi->backofficeIntegrationAuthorize: %s\n" % e)

Parameters

Path parameters
Name Description
type*
String
Integration type
Required

Responses

Status: 302 - Redirect

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeIntegrationConfigure

configure backoffice_integration

Configure integration.


/0.0.1/backoffice/integrations/{type}/{id}/configure

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/integrations/{type}/{id}/configure"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeIntegrationApi;

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

public class BackofficeIntegrationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeIntegrationApi apiInstance = new BackofficeIntegrationApi();
        String id = id_example; // String | Integration ID
        String type = type_example; // String | Integration type
        String organisation = organisation_example; // String | 
        try {
            Integration_config result = apiInstance.backofficeIntegrationConfigure(id, type, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeIntegrationApi#backofficeIntegrationConfigure");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeIntegrationApi;

public class BackofficeIntegrationApiExample {

    public static void main(String[] args) {
        BackofficeIntegrationApi apiInstance = new BackofficeIntegrationApi();
        String id = id_example; // String | Integration ID
        String type = type_example; // String | Integration type
        String organisation = organisation_example; // String | 
        try {
            Integration_config result = apiInstance.backofficeIntegrationConfigure(id, type, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeIntegrationApi#backofficeIntegrationConfigure");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Integration ID
String *type = type_example; // Integration type
String *organisation = organisation_example; // 

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

// configure backoffice_integration
[apiInstance backofficeIntegrationConfigureWith:id
    type:type
    organisation:organisation
              completionHandler: ^(Integration_config output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeIntegrationApi()

var id = id_example; // {String} Integration ID

var type = type_example; // {String} Integration type

var organisation = organisation_example; // {String} 

api.backofficeIntegrationConfigure(id, type, organisation).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeIntegrationConfigureExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeIntegrationApi();
            var id = id_example;  // String | Integration ID
            var type = type_example;  // String | Integration type
            var organisation = organisation_example;  // String | 

            try
            {
                // configure backoffice_integration
                Integration_config result = apiInstance.backofficeIntegrationConfigure(id, type, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeIntegrationApi.backofficeIntegrationConfigure: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeIntegrationApi();
$id = id_example; // String | Integration ID
$type = type_example; // String | Integration type
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeIntegrationConfigure($id, $type, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeIntegrationApi->backofficeIntegrationConfigure: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeIntegrationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeIntegrationApi->new();
my $id = id_example; # String | Integration ID
my $type = type_example; # String | Integration type
my $organisation = organisation_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeIntegrationApi()
id = id_example # String | Integration ID
type = type_example # String | Integration type
organisation = organisation_example # String | 

try: 
    # configure backoffice_integration
    api_response = api_instance.backoffice_integration_configure(id, type, organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeIntegrationApi->backofficeIntegrationConfigure: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Integration ID
Required
type*
String
Integration type
Required
Header parameters
Name Description
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeIntegrationConfigureView

configure_view backoffice_integration

Integration configure view.


/0.0.1/backoffice/integrations/{type}/configure_view

Usage and SDK Samples

curl -X GET "https://api.quriobot.com/0.0.1/backoffice/integrations/{type}/configure_view"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeIntegrationApi;

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

public class BackofficeIntegrationApiExample {

    public static void main(String[] args) {
        
        BackofficeIntegrationApi apiInstance = new BackofficeIntegrationApi();
        String type = type_example; // String | Integration type
        try {
            apiInstance.backofficeIntegrationConfigureView(type);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeIntegrationApi#backofficeIntegrationConfigureView");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeIntegrationApi;

public class BackofficeIntegrationApiExample {

    public static void main(String[] args) {
        BackofficeIntegrationApi apiInstance = new BackofficeIntegrationApi();
        String type = type_example; // String | Integration type
        try {
            apiInstance.backofficeIntegrationConfigureView(type);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeIntegrationApi#backofficeIntegrationConfigureView");
            e.printStackTrace();
        }
    }
}
String *type = type_example; // Integration type

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

// configure_view backoffice_integration
[apiInstance backofficeIntegrationConfigureViewWith:type
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.BackofficeIntegrationApi()

var type = type_example; // {String} Integration type

api.backofficeIntegrationConfigureView(type).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeIntegrationConfigureViewExample
    {
        public void main()
        {
            
            var apiInstance = new BackofficeIntegrationApi();
            var type = type_example;  // String | Integration type

            try
            {
                // configure_view backoffice_integration
                apiInstance.backofficeIntegrationConfigureView(type);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeIntegrationApi.backofficeIntegrationConfigureView: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BackofficeIntegrationApi();
$type = type_example; // String | Integration type

try {
    $api_instance->backofficeIntegrationConfigureView($type);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeIntegrationApi->backofficeIntegrationConfigureView: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeIntegrationApi;

my $api_instance = WWW::SwaggerClient::BackofficeIntegrationApi->new();
my $type = type_example; # String | Integration type

eval { 
    $api_instance->backofficeIntegrationConfigureView(type => $type);
};
if ($@) {
    warn "Exception when calling BackofficeIntegrationApi->backofficeIntegrationConfigureView: $@\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.BackofficeIntegrationApi()
type = type_example # String | Integration type

try: 
    # configure_view backoffice_integration
    api_instance.backoffice_integration_configure_view(type)
except ApiException as e:
    print("Exception when calling BackofficeIntegrationApi->backofficeIntegrationConfigureView: %s\n" % e)

Parameters

Path parameters
Name Description
type*
String
Integration type
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeIntegrationCreate

create backoffice_integration

Create integration


/0.0.1/backoffice/integrations/{type}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/integrations/{type}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeIntegrationApi;

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

public class BackofficeIntegrationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeIntegrationApi apiInstance = new BackofficeIntegrationApi();
        String type = type_example; // String | Integration type
        String organisation = organisation_example; // String | 
        IntegrationCreatePayload payload = ; // IntegrationCreatePayload | Integration payload
        try {
            Integration result = apiInstance.backofficeIntegrationCreate(type, organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeIntegrationApi#backofficeIntegrationCreate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeIntegrationApi;

public class BackofficeIntegrationApiExample {

    public static void main(String[] args) {
        BackofficeIntegrationApi apiInstance = new BackofficeIntegrationApi();
        String type = type_example; // String | Integration type
        String organisation = organisation_example; // String | 
        IntegrationCreatePayload payload = ; // IntegrationCreatePayload | Integration payload
        try {
            Integration result = apiInstance.backofficeIntegrationCreate(type, organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeIntegrationApi#backofficeIntegrationCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *type = type_example; // Integration type
String *organisation = organisation_example; // 
IntegrationCreatePayload *payload = ; // Integration payload

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

// create backoffice_integration
[apiInstance backofficeIntegrationCreateWith:type
    organisation:organisation
    payload:payload
              completionHandler: ^(Integration output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeIntegrationApi()

var type = type_example; // {String} Integration type

var organisation = organisation_example; // {String} 

var payload = ; // {IntegrationCreatePayload} Integration payload

api.backofficeIntegrationCreate(type, organisation, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeIntegrationCreateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeIntegrationApi();
            var type = type_example;  // String | Integration type
            var organisation = organisation_example;  // String | 
            var payload = new IntegrationCreatePayload(); // IntegrationCreatePayload | Integration payload

            try
            {
                // create backoffice_integration
                Integration result = apiInstance.backofficeIntegrationCreate(type, organisation, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeIntegrationApi.backofficeIntegrationCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeIntegrationApi();
$type = type_example; // String | Integration type
$organisation = organisation_example; // String | 
$payload = ; // IntegrationCreatePayload | Integration payload

try {
    $result = $api_instance->backofficeIntegrationCreate($type, $organisation, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeIntegrationApi->backofficeIntegrationCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeIntegrationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeIntegrationApi->new();
my $type = type_example; # String | Integration type
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::IntegrationCreatePayload->new(); # IntegrationCreatePayload | Integration payload

eval { 
    my $result = $api_instance->backofficeIntegrationCreate(type => $type, organisation => $organisation, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeIntegrationApi->backofficeIntegrationCreate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeIntegrationApi()
type = type_example # String | Integration type
organisation = organisation_example # String | 
payload =  # IntegrationCreatePayload | Integration payload

try: 
    # create backoffice_integration
    api_response = api_instance.backoffice_integration_create(type, organisation, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeIntegrationApi->backofficeIntegrationCreate: %s\n" % e)

Parameters

Path parameters
Name Description
type*
String
Integration type
Required
Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeIntegrationDelete

delete backoffice_integration


/0.0.1/backoffice/integrations/{type}/{id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/integrations/{type}/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeIntegrationApi;

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

public class BackofficeIntegrationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeIntegrationApi apiInstance = new BackofficeIntegrationApi();
        String id = id_example; // String | Integration ID
        String type = type_example; // String | Integration type
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeIntegrationDelete(id, type, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeIntegrationApi#backofficeIntegrationDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeIntegrationApi;

public class BackofficeIntegrationApiExample {

    public static void main(String[] args) {
        BackofficeIntegrationApi apiInstance = new BackofficeIntegrationApi();
        String id = id_example; // String | Integration ID
        String type = type_example; // String | Integration type
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeIntegrationDelete(id, type, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeIntegrationApi#backofficeIntegrationDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Integration ID
String *type = type_example; // Integration type
String *organisation = organisation_example; // 

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

// delete backoffice_integration
[apiInstance backofficeIntegrationDeleteWith:id
    type:type
    organisation:organisation
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeIntegrationApi()

var id = id_example; // {String} Integration ID

var type = type_example; // {String} Integration type

var organisation = organisation_example; // {String} 

api.backofficeIntegrationDelete(id, type, organisation).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeIntegrationDeleteExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeIntegrationApi();
            var id = id_example;  // String | Integration ID
            var type = type_example;  // String | Integration type
            var organisation = organisation_example;  // String | 

            try
            {
                // delete backoffice_integration
                apiInstance.backofficeIntegrationDelete(id, type, organisation);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeIntegrationApi.backofficeIntegrationDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeIntegrationApi();
$id = id_example; // String | Integration ID
$type = type_example; // String | Integration type
$organisation = organisation_example; // String | 

try {
    $api_instance->backofficeIntegrationDelete($id, $type, $organisation);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeIntegrationApi->backofficeIntegrationDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeIntegrationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeIntegrationApi->new();
my $id = id_example; # String | Integration ID
my $type = type_example; # String | Integration type
my $organisation = organisation_example; # String | 

eval { 
    $api_instance->backofficeIntegrationDelete(id => $id, type => $type, organisation => $organisation);
};
if ($@) {
    warn "Exception when calling BackofficeIntegrationApi->backofficeIntegrationDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeIntegrationApi()
id = id_example # String | Integration ID
type = type_example # String | Integration type
organisation = organisation_example # String | 

try: 
    # delete backoffice_integration
    api_instance.backoffice_integration_delete(id, type, organisation)
except ApiException as e:
    print("Exception when calling BackofficeIntegrationApi->backofficeIntegrationDelete: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Integration ID
Required
type*
String
Integration type
Required
Header parameters
Name Description
Organisation*
String
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeIntegrationList

list backoffice_integration

Retrieve all integrations.


/0.0.1/backoffice/integrations/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/integrations/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeIntegrationApi;

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

public class BackofficeIntegrationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeIntegrationApi apiInstance = new BackofficeIntegrationApi();
        String organisation = organisation_example; // String | 
        IntegrationCollectionPayload payload = ; // IntegrationCollectionPayload | Integration collection payload
        try {
            Integration_collection result = apiInstance.backofficeIntegrationList(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeIntegrationApi#backofficeIntegrationList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeIntegrationApi;

public class BackofficeIntegrationApiExample {

    public static void main(String[] args) {
        BackofficeIntegrationApi apiInstance = new BackofficeIntegrationApi();
        String organisation = organisation_example; // String | 
        IntegrationCollectionPayload payload = ; // IntegrationCollectionPayload | Integration collection payload
        try {
            Integration_collection result = apiInstance.backofficeIntegrationList(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeIntegrationApi#backofficeIntegrationList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
IntegrationCollectionPayload *payload = ; // Integration collection payload

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

// list backoffice_integration
[apiInstance backofficeIntegrationListWith:organisation
    payload:payload
              completionHandler: ^(Integration_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeIntegrationApi()

var organisation = organisation_example; // {String} 

var payload = ; // {IntegrationCollectionPayload} Integration collection payload

api.backofficeIntegrationList(organisation, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeIntegrationListExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeIntegrationApi();
            var organisation = organisation_example;  // String | 
            var payload = new IntegrationCollectionPayload(); // IntegrationCollectionPayload | Integration collection payload

            try
            {
                // list backoffice_integration
                Integration_collection result = apiInstance.backofficeIntegrationList(organisation, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeIntegrationApi.backofficeIntegrationList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeIntegrationApi();
$organisation = organisation_example; // String | 
$payload = ; // IntegrationCollectionPayload | Integration collection payload

try {
    $result = $api_instance->backofficeIntegrationList($organisation, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeIntegrationApi->backofficeIntegrationList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeIntegrationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeIntegrationApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::IntegrationCollectionPayload->new(); # IntegrationCollectionPayload | Integration collection payload

eval { 
    my $result = $api_instance->backofficeIntegrationList(organisation => $organisation, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeIntegrationApi->backofficeIntegrationList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeIntegrationApi()
organisation = organisation_example # String | 
payload =  # IntegrationCollectionPayload | Integration collection payload

try: 
    # list backoffice_integration
    api_response = api_instance.backoffice_integration_list(organisation, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeIntegrationApi->backofficeIntegrationList: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeIntegrationListType

list_type backoffice_integration

Retrieve all integration types.


/0.0.1/backoffice/integrations/types

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/backoffice/integrations/types"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeIntegrationApi;

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

public class BackofficeIntegrationApiExample {

    public static void main(String[] args) {
        
        BackofficeIntegrationApi apiInstance = new BackofficeIntegrationApi();
        String organisation = organisation_example; // String | 
        IntegrationTypeCollectionPayload payload = ; // IntegrationTypeCollectionPayload | Integration type collection payload
        try {
            Integration_type_collection result = apiInstance.backofficeIntegrationListType(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeIntegrationApi#backofficeIntegrationListType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeIntegrationApi;

public class BackofficeIntegrationApiExample {

    public static void main(String[] args) {
        BackofficeIntegrationApi apiInstance = new BackofficeIntegrationApi();
        String organisation = organisation_example; // String | 
        IntegrationTypeCollectionPayload payload = ; // IntegrationTypeCollectionPayload | Integration type collection payload
        try {
            Integration_type_collection result = apiInstance.backofficeIntegrationListType(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeIntegrationApi#backofficeIntegrationListType");
            e.printStackTrace();
        }
    }
}
String *organisation = organisation_example; // 
IntegrationTypeCollectionPayload *payload = ; // Integration type collection payload

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

// list_type backoffice_integration
[apiInstance backofficeIntegrationListTypeWith:organisation
    payload:payload
              completionHandler: ^(Integration_type_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.BackofficeIntegrationApi()

var organisation = organisation_example; // {String} 

var payload = ; // {IntegrationTypeCollectionPayload} Integration type collection payload

api.backofficeIntegrationListType(organisation, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeIntegrationListTypeExample
    {
        public void main()
        {
            
            var apiInstance = new BackofficeIntegrationApi();
            var organisation = organisation_example;  // String | 
            var payload = new IntegrationTypeCollectionPayload(); // IntegrationTypeCollectionPayload | Integration type collection payload

            try
            {
                // list_type backoffice_integration
                Integration_type_collection result = apiInstance.backofficeIntegrationListType(organisation, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeIntegrationApi.backofficeIntegrationListType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BackofficeIntegrationApi();
$organisation = organisation_example; // String | 
$payload = ; // IntegrationTypeCollectionPayload | Integration type collection payload

try {
    $result = $api_instance->backofficeIntegrationListType($organisation, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeIntegrationApi->backofficeIntegrationListType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeIntegrationApi;

my $api_instance = WWW::SwaggerClient::BackofficeIntegrationApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::IntegrationTypeCollectionPayload->new(); # IntegrationTypeCollectionPayload | Integration type collection payload

eval { 
    my $result = $api_instance->backofficeIntegrationListType(organisation => $organisation, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeIntegrationApi->backofficeIntegrationListType: $@\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.BackofficeIntegrationApi()
organisation = organisation_example # String | 
payload =  # IntegrationTypeCollectionPayload | Integration type collection payload

try: 
    # list_type backoffice_integration
    api_response = api_instance.backoffice_integration_list_type(organisation, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeIntegrationApi->backofficeIntegrationListType: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeIntegrationShow

show backoffice_integration

Get integration


/0.0.1/backoffice/integrations/{type}/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/integrations/{type}/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeIntegrationApi;

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

public class BackofficeIntegrationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeIntegrationApi apiInstance = new BackofficeIntegrationApi();
        String id = id_example; // String | Integration ID
        String type = type_example; // String | Integration type
        String organisation = organisation_example; // String | 
        try {
            Integration result = apiInstance.backofficeIntegrationShow(id, type, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeIntegrationApi#backofficeIntegrationShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeIntegrationApi;

public class BackofficeIntegrationApiExample {

    public static void main(String[] args) {
        BackofficeIntegrationApi apiInstance = new BackofficeIntegrationApi();
        String id = id_example; // String | Integration ID
        String type = type_example; // String | Integration type
        String organisation = organisation_example; // String | 
        try {
            Integration result = apiInstance.backofficeIntegrationShow(id, type, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeIntegrationApi#backofficeIntegrationShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Integration ID
String *type = type_example; // Integration type
String *organisation = organisation_example; // 

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

// show backoffice_integration
[apiInstance backofficeIntegrationShowWith:id
    type:type
    organisation:organisation
              completionHandler: ^(Integration output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeIntegrationApi()

var id = id_example; // {String} Integration ID

var type = type_example; // {String} Integration type

var organisation = organisation_example; // {String} 

api.backofficeIntegrationShow(id, type, organisation).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeIntegrationShowExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeIntegrationApi();
            var id = id_example;  // String | Integration ID
            var type = type_example;  // String | Integration type
            var organisation = organisation_example;  // String | 

            try
            {
                // show backoffice_integration
                Integration result = apiInstance.backofficeIntegrationShow(id, type, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeIntegrationApi.backofficeIntegrationShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeIntegrationApi();
$id = id_example; // String | Integration ID
$type = type_example; // String | Integration type
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeIntegrationShow($id, $type, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeIntegrationApi->backofficeIntegrationShow: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeIntegrationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeIntegrationApi->new();
my $id = id_example; # String | Integration ID
my $type = type_example; # String | Integration type
my $organisation = organisation_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeIntegrationApi()
id = id_example # String | Integration ID
type = type_example # String | Integration type
organisation = organisation_example # String | 

try: 
    # show backoffice_integration
    api_response = api_instance.backoffice_integration_show(id, type, organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeIntegrationApi->backofficeIntegrationShow: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Integration ID
Required
type*
String
Integration type
Required
Header parameters
Name Description
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeIntegrationShowOpenAiAutomationRuleActionLogItems

show_open_ai_automation_rule_action_log_items backoffice_integration

Retrieve integration automation rule action log items.


/0.0.1/backoffice/integrations/open_ai/{id}/automation_rule_action_log_items/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/integrations/open_ai/{id}/automation_rule_action_log_items/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeIntegrationApi;

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

public class BackofficeIntegrationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeIntegrationApi apiInstance = new BackofficeIntegrationApi();
        String id = id_example; // String | Integration ID
        String organisation = organisation_example; // String | 
        OpenAIIntegrationAutomationRuleActionLogItemCollectionPayload payload = ; // OpenAIIntegrationAutomationRuleActionLogItemCollectionPayload | OpenAI integration automation rule action log item collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Open_ai_integration_automation_rule_action_log_item_collection result = apiInstance.backofficeIntegrationShowOpenAiAutomationRuleActionLogItems(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeIntegrationApi#backofficeIntegrationShowOpenAiAutomationRuleActionLogItems");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeIntegrationApi;

public class BackofficeIntegrationApiExample {

    public static void main(String[] args) {
        BackofficeIntegrationApi apiInstance = new BackofficeIntegrationApi();
        String id = id_example; // String | Integration ID
        String organisation = organisation_example; // String | 
        OpenAIIntegrationAutomationRuleActionLogItemCollectionPayload payload = ; // OpenAIIntegrationAutomationRuleActionLogItemCollectionPayload | OpenAI integration automation rule action log item collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        try {
            Open_ai_integration_automation_rule_action_log_item_collection result = apiInstance.backofficeIntegrationShowOpenAiAutomationRuleActionLogItems(id, organisation, payload, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeIntegrationApi#backofficeIntegrationShowOpenAiAutomationRuleActionLogItems");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Integration ID
String *organisation = organisation_example; // 
OpenAIIntegrationAutomationRuleActionLogItemCollectionPayload *payload = ; // OpenAI integration automation rule action log item collection payload
String *acceptLanguage = acceptLanguage_example; //  (optional)

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

// show_open_ai_automation_rule_action_log_items backoffice_integration
[apiInstance backofficeIntegrationShowOpenAiAutomationRuleActionLogItemsWith:id
    organisation:organisation
    payload:payload
    acceptLanguage:acceptLanguage
              completionHandler: ^(Open_ai_integration_automation_rule_action_log_item_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeIntegrationApi()

var id = id_example; // {String} Integration ID

var organisation = organisation_example; // {String} 

var payload = ; // {OpenAIIntegrationAutomationRuleActionLogItemCollectionPayload} OpenAI integration automation rule action log item collection payload

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} 
};
api.backofficeIntegrationShowOpenAiAutomationRuleActionLogItems(id, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeIntegrationShowOpenAiAutomationRuleActionLogItemsExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeIntegrationApi();
            var id = id_example;  // String | Integration ID
            var organisation = organisation_example;  // String | 
            var payload = new OpenAIIntegrationAutomationRuleActionLogItemCollectionPayload(); // OpenAIIntegrationAutomationRuleActionLogItemCollectionPayload | OpenAI integration automation rule action log item collection payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 

            try
            {
                // show_open_ai_automation_rule_action_log_items backoffice_integration
                Open_ai_integration_automation_rule_action_log_item_collection result = apiInstance.backofficeIntegrationShowOpenAiAutomationRuleActionLogItems(id, organisation, payload, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeIntegrationApi.backofficeIntegrationShowOpenAiAutomationRuleActionLogItems: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeIntegrationApi();
$id = id_example; // String | Integration ID
$organisation = organisation_example; // String | 
$payload = ; // OpenAIIntegrationAutomationRuleActionLogItemCollectionPayload | OpenAI integration automation rule action log item collection payload
$acceptLanguage = acceptLanguage_example; // String | 

try {
    $result = $api_instance->backofficeIntegrationShowOpenAiAutomationRuleActionLogItems($id, $organisation, $payload, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeIntegrationApi->backofficeIntegrationShowOpenAiAutomationRuleActionLogItems: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeIntegrationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeIntegrationApi->new();
my $id = id_example; # String | Integration ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::OpenAIIntegrationAutomationRuleActionLogItemCollectionPayload->new(); # OpenAIIntegrationAutomationRuleActionLogItemCollectionPayload | OpenAI integration automation rule action log item collection payload
my $acceptLanguage = acceptLanguage_example; # String | 

eval { 
    my $result = $api_instance->backofficeIntegrationShowOpenAiAutomationRuleActionLogItems(id => $id, organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeIntegrationApi->backofficeIntegrationShowOpenAiAutomationRuleActionLogItems: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeIntegrationApi()
id = id_example # String | Integration ID
organisation = organisation_example # String | 
payload =  # OpenAIIntegrationAutomationRuleActionLogItemCollectionPayload | OpenAI integration automation rule action log item collection payload
acceptLanguage = acceptLanguage_example # String |  (optional)

try: 
    # show_open_ai_automation_rule_action_log_items backoffice_integration
    api_response = api_instance.backoffice_integration_show_open_ai_automation_rule_action_log_items(id, organisation, payload, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeIntegrationApi->backofficeIntegrationShowOpenAiAutomationRuleActionLogItems: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Integration ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeIntegrationUpdate

update backoffice_integration

Change integration


/0.0.1/backoffice/integrations/{type}/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/integrations/{type}/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeIntegrationApi;

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

public class BackofficeIntegrationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeIntegrationApi apiInstance = new BackofficeIntegrationApi();
        String id = id_example; // String | Integration ID
        String type = type_example; // String | Integration type
        String organisation = organisation_example; // String | 
        IntegrationUpdatePayload payload = ; // IntegrationUpdatePayload | Integration update payload
        try {
            Integration result = apiInstance.backofficeIntegrationUpdate(id, type, organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeIntegrationApi#backofficeIntegrationUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeIntegrationApi;

public class BackofficeIntegrationApiExample {

    public static void main(String[] args) {
        BackofficeIntegrationApi apiInstance = new BackofficeIntegrationApi();
        String id = id_example; // String | Integration ID
        String type = type_example; // String | Integration type
        String organisation = organisation_example; // String | 
        IntegrationUpdatePayload payload = ; // IntegrationUpdatePayload | Integration update payload
        try {
            Integration result = apiInstance.backofficeIntegrationUpdate(id, type, organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeIntegrationApi#backofficeIntegrationUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Integration ID
String *type = type_example; // Integration type
String *organisation = organisation_example; // 
IntegrationUpdatePayload *payload = ; // Integration update payload

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

// update backoffice_integration
[apiInstance backofficeIntegrationUpdateWith:id
    type:type
    organisation:organisation
    payload:payload
              completionHandler: ^(Integration output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeIntegrationApi()

var id = id_example; // {String} Integration ID

var type = type_example; // {String} Integration type

var organisation = organisation_example; // {String} 

var payload = ; // {IntegrationUpdatePayload} Integration update payload

api.backofficeIntegrationUpdate(id, type, organisation, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeIntegrationUpdateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeIntegrationApi();
            var id = id_example;  // String | Integration ID
            var type = type_example;  // String | Integration type
            var organisation = organisation_example;  // String | 
            var payload = new IntegrationUpdatePayload(); // IntegrationUpdatePayload | Integration update payload

            try
            {
                // update backoffice_integration
                Integration result = apiInstance.backofficeIntegrationUpdate(id, type, organisation, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeIntegrationApi.backofficeIntegrationUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeIntegrationApi();
$id = id_example; // String | Integration ID
$type = type_example; // String | Integration type
$organisation = organisation_example; // String | 
$payload = ; // IntegrationUpdatePayload | Integration update payload

try {
    $result = $api_instance->backofficeIntegrationUpdate($id, $type, $organisation, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeIntegrationApi->backofficeIntegrationUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeIntegrationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeIntegrationApi->new();
my $id = id_example; # String | Integration ID
my $type = type_example; # String | Integration type
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::IntegrationUpdatePayload->new(); # IntegrationUpdatePayload | Integration update payload

eval { 
    my $result = $api_instance->backofficeIntegrationUpdate(id => $id, type => $type, organisation => $organisation, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeIntegrationApi->backofficeIntegrationUpdate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeIntegrationApi()
id = id_example # String | Integration ID
type = type_example # String | Integration type
organisation = organisation_example # String | 
payload =  # IntegrationUpdatePayload | Integration update payload

try: 
    # update backoffice_integration
    api_response = api_instance.backoffice_integration_update(id, type, organisation, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeIntegrationApi->backofficeIntegrationUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Integration ID
Required
type*
String
Integration type
Required
Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


BackofficeInvite

backofficeInviteAccept

accept backoffice_invite

Confirm backoffice user invitation


/0.0.1/backoffice/invites/accept

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/backoffice/invites/accept"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeInviteApi;

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

public class BackofficeInviteApiExample {

    public static void main(String[] args) {
        
        BackofficeInviteApi apiInstance = new BackofficeInviteApi();
        BoUserInviteAcceptPayload payload = ; // BoUserInviteAcceptPayload | A backoffice user invite accept payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user result = apiInstance.backofficeInviteAccept(payload, acceptLanguage, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeInviteApi#backofficeInviteAccept");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeInviteApi;

public class BackofficeInviteApiExample {

    public static void main(String[] args) {
        BackofficeInviteApi apiInstance = new BackofficeInviteApi();
        BoUserInviteAcceptPayload payload = ; // BoUserInviteAcceptPayload | A backoffice user invite accept payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user result = apiInstance.backofficeInviteAccept(payload, acceptLanguage, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeInviteApi#backofficeInviteAccept");
            e.printStackTrace();
        }
    }
}
BoUserInviteAcceptPayload *payload = ; // A backoffice user invite accept payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// accept backoffice_invite
[apiInstance backofficeInviteAcceptWith:payload
    acceptLanguage:acceptLanguage
    xForwardedFor:xForwardedFor
              completionHandler: ^(Bo_user output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.BackofficeInviteApi()

var payload = ; // {BoUserInviteAcceptPayload} A backoffice user invite accept payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeInviteAccept(payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeInviteAcceptExample
    {
        public void main()
        {
            
            var apiInstance = new BackofficeInviteApi();
            var payload = new BoUserInviteAcceptPayload(); // BoUserInviteAcceptPayload | A backoffice user invite accept payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // accept backoffice_invite
                Bo_user result = apiInstance.backofficeInviteAccept(payload, acceptLanguage, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeInviteApi.backofficeInviteAccept: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BackofficeInviteApi();
$payload = ; // BoUserInviteAcceptPayload | A backoffice user invite accept payload
$acceptLanguage = acceptLanguage_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->backofficeInviteAccept($payload, $acceptLanguage, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeInviteApi->backofficeInviteAccept: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeInviteApi;

my $api_instance = WWW::SwaggerClient::BackofficeInviteApi->new();
my $payload = WWW::SwaggerClient::Object::BoUserInviteAcceptPayload->new(); # BoUserInviteAcceptPayload | A backoffice user invite accept payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->backofficeInviteAccept(payload => $payload, acceptLanguage => $acceptLanguage, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeInviteApi->backofficeInviteAccept: $@\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.BackofficeInviteApi()
payload =  # BoUserInviteAcceptPayload | A backoffice user invite accept payload
acceptLanguage = acceptLanguage_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # accept backoffice_invite
    api_response = api_instance.backoffice_invite_accept(payload, acceptLanguage=acceptLanguage, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeInviteApi->backofficeInviteAccept: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Name Type Format Description
Authorization String Generated JWT
Authorization-Token-Expires String Expiration of the authorization token

Status: 400 - Bad Request


backofficeInviteCreate

create backoffice_invite

Create new backoffice invite


/0.0.1/backoffice/invites

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/invites"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeInviteApi;

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

public class BackofficeInviteApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeInviteApi apiInstance = new BackofficeInviteApi();
        String organisation = organisation_example; // String | 
        BoUserInviteCreatePayload payload = ; // BoUserInviteCreatePayload | Invite create payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user_invite result = apiInstance.backofficeInviteCreate(organisation, payload, acceptLanguage, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeInviteApi#backofficeInviteCreate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeInviteApi;

public class BackofficeInviteApiExample {

    public static void main(String[] args) {
        BackofficeInviteApi apiInstance = new BackofficeInviteApi();
        String organisation = organisation_example; // String | 
        BoUserInviteCreatePayload payload = ; // BoUserInviteCreatePayload | Invite create payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user_invite result = apiInstance.backofficeInviteCreate(organisation, payload, acceptLanguage, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeInviteApi#backofficeInviteCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
BoUserInviteCreatePayload *payload = ; // Invite create payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// create backoffice_invite
[apiInstance backofficeInviteCreateWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    xForwardedFor:xForwardedFor
              completionHandler: ^(Bo_user_invite output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeInviteApi()

var organisation = organisation_example; // {String} 

var payload = ; // {BoUserInviteCreatePayload} Invite create payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeInviteCreate(organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeInviteCreateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeInviteApi();
            var organisation = organisation_example;  // String | 
            var payload = new BoUserInviteCreatePayload(); // BoUserInviteCreatePayload | Invite create payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // create backoffice_invite
                Bo_user_invite result = apiInstance.backofficeInviteCreate(organisation, payload, acceptLanguage, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeInviteApi.backofficeInviteCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeInviteApi();
$organisation = organisation_example; // String | 
$payload = ; // BoUserInviteCreatePayload | Invite create payload
$acceptLanguage = acceptLanguage_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->backofficeInviteCreate($organisation, $payload, $acceptLanguage, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeInviteApi->backofficeInviteCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeInviteApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeInviteApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::BoUserInviteCreatePayload->new(); # BoUserInviteCreatePayload | Invite create payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->backofficeInviteCreate(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeInviteApi->backofficeInviteCreate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeInviteApi()
organisation = organisation_example # String | 
payload =  # BoUserInviteCreatePayload | Invite create payload
acceptLanguage = acceptLanguage_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # create backoffice_invite
    api_response = api_instance.backoffice_invite_create(organisation, payload, acceptLanguage=acceptLanguage, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeInviteApi->backofficeInviteCreate: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Organisation*
String
Required
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeInviteDelete

delete backoffice_invite


/0.0.1/backoffice/invites

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/invites"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeInviteApi;

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

public class BackofficeInviteApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeInviteApi apiInstance = new BackofficeInviteApi();
        BoUserInviteActionPayload payload = ; // BoUserInviteActionPayload | Backoffice user invite action payload
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeInviteDelete(payload, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeInviteApi#backofficeInviteDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeInviteApi;

public class BackofficeInviteApiExample {

    public static void main(String[] args) {
        BackofficeInviteApi apiInstance = new BackofficeInviteApi();
        BoUserInviteActionPayload payload = ; // BoUserInviteActionPayload | Backoffice user invite action payload
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeInviteDelete(payload, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeInviteApi#backofficeInviteDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

BoUserInviteActionPayload *payload = ; // Backoffice user invite action payload
String *organisation = organisation_example; //  (optional)

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

// delete backoffice_invite
[apiInstance backofficeInviteDeleteWith:payload
    organisation:organisation
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeInviteApi()

var payload = ; // {BoUserInviteActionPayload} Backoffice user invite action payload

var opts = { 
  'organisation': organisation_example // {String} 
};
api.backofficeInviteDelete(payload, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeInviteDeleteExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeInviteApi();
            var payload = new BoUserInviteActionPayload(); // BoUserInviteActionPayload | Backoffice user invite action payload
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // delete backoffice_invite
                apiInstance.backofficeInviteDelete(payload, organisation);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeInviteApi.backofficeInviteDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeInviteApi();
$payload = ; // BoUserInviteActionPayload | Backoffice user invite action payload
$organisation = organisation_example; // String | 

try {
    $api_instance->backofficeInviteDelete($payload, $organisation);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeInviteApi->backofficeInviteDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeInviteApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeInviteApi->new();
my $payload = WWW::SwaggerClient::Object::BoUserInviteActionPayload->new(); # BoUserInviteActionPayload | Backoffice user invite action payload
my $organisation = organisation_example; # String | 

eval { 
    $api_instance->backofficeInviteDelete(payload => $payload, organisation => $organisation);
};
if ($@) {
    warn "Exception when calling BackofficeInviteApi->backofficeInviteDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeInviteApi()
payload =  # BoUserInviteActionPayload | Backoffice user invite action payload
organisation = organisation_example # String |  (optional)

try: 
    # delete backoffice_invite
    api_instance.backoffice_invite_delete(payload, organisation=organisation)
except ApiException as e:
    print("Exception when calling BackofficeInviteApi->backofficeInviteDelete: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeInviteList

list backoffice_invite

Retrieve all invites.


/0.0.1/backoffice/invites/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/invites/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeInviteApi;

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

public class BackofficeInviteApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeInviteApi apiInstance = new BackofficeInviteApi();
        String organisation = organisation_example; // String | 
        BoUserInviteCollectionPayload payload = ; // BoUserInviteCollectionPayload | User invite collection payload
        try {
            Bo_user_invite_collection result = apiInstance.backofficeInviteList(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeInviteApi#backofficeInviteList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeInviteApi;

public class BackofficeInviteApiExample {

    public static void main(String[] args) {
        BackofficeInviteApi apiInstance = new BackofficeInviteApi();
        String organisation = organisation_example; // String | 
        BoUserInviteCollectionPayload payload = ; // BoUserInviteCollectionPayload | User invite collection payload
        try {
            Bo_user_invite_collection result = apiInstance.backofficeInviteList(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeInviteApi#backofficeInviteList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
BoUserInviteCollectionPayload *payload = ; // User invite collection payload

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

// list backoffice_invite
[apiInstance backofficeInviteListWith:organisation
    payload:payload
              completionHandler: ^(Bo_user_invite_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeInviteApi()

var organisation = organisation_example; // {String} 

var payload = ; // {BoUserInviteCollectionPayload} User invite collection payload

api.backofficeInviteList(organisation, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeInviteListExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeInviteApi();
            var organisation = organisation_example;  // String | 
            var payload = new BoUserInviteCollectionPayload(); // BoUserInviteCollectionPayload | User invite collection payload

            try
            {
                // list backoffice_invite
                Bo_user_invite_collection result = apiInstance.backofficeInviteList(organisation, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeInviteApi.backofficeInviteList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeInviteApi();
$organisation = organisation_example; // String | 
$payload = ; // BoUserInviteCollectionPayload | User invite collection payload

try {
    $result = $api_instance->backofficeInviteList($organisation, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeInviteApi->backofficeInviteList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeInviteApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeInviteApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::BoUserInviteCollectionPayload->new(); # BoUserInviteCollectionPayload | User invite collection payload

eval { 
    my $result = $api_instance->backofficeInviteList(organisation => $organisation, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeInviteApi->backofficeInviteList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeInviteApi()
organisation = organisation_example # String | 
payload =  # BoUserInviteCollectionPayload | User invite collection payload

try: 
    # list backoffice_invite
    api_response = api_instance.backoffice_invite_list(organisation, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeInviteApi->backofficeInviteList: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeInviteResend

resend backoffice_invite


/0.0.1/backoffice/invites/resend

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/invites/resend"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeInviteApi;

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

public class BackofficeInviteApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeInviteApi apiInstance = new BackofficeInviteApi();
        BoUserInviteActionPayload payload = ; // BoUserInviteActionPayload | Backoffice user invite action payload
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeInviteResend(payload, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeInviteApi#backofficeInviteResend");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeInviteApi;

public class BackofficeInviteApiExample {

    public static void main(String[] args) {
        BackofficeInviteApi apiInstance = new BackofficeInviteApi();
        BoUserInviteActionPayload payload = ; // BoUserInviteActionPayload | Backoffice user invite action payload
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeInviteResend(payload, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeInviteApi#backofficeInviteResend");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

BoUserInviteActionPayload *payload = ; // Backoffice user invite action payload
String *organisation = organisation_example; //  (optional)

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

// resend backoffice_invite
[apiInstance backofficeInviteResendWith:payload
    organisation:organisation
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeInviteApi()

var payload = ; // {BoUserInviteActionPayload} Backoffice user invite action payload

var opts = { 
  'organisation': organisation_example // {String} 
};
api.backofficeInviteResend(payload, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeInviteResendExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeInviteApi();
            var payload = new BoUserInviteActionPayload(); // BoUserInviteActionPayload | Backoffice user invite action payload
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // resend backoffice_invite
                apiInstance.backofficeInviteResend(payload, organisation);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeInviteApi.backofficeInviteResend: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeInviteApi();
$payload = ; // BoUserInviteActionPayload | Backoffice user invite action payload
$organisation = organisation_example; // String | 

try {
    $api_instance->backofficeInviteResend($payload, $organisation);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeInviteApi->backofficeInviteResend: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeInviteApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeInviteApi->new();
my $payload = WWW::SwaggerClient::Object::BoUserInviteActionPayload->new(); # BoUserInviteActionPayload | Backoffice user invite action payload
my $organisation = organisation_example; # String | 

eval { 
    $api_instance->backofficeInviteResend(payload => $payload, organisation => $organisation);
};
if ($@) {
    warn "Exception when calling BackofficeInviteApi->backofficeInviteResend: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeInviteApi()
payload =  # BoUserInviteActionPayload | Backoffice user invite action payload
organisation = organisation_example # String |  (optional)

try: 
    # resend backoffice_invite
    api_instance.backoffice_invite_resend(payload, organisation=organisation)
except ApiException as e:
    print("Exception when calling BackofficeInviteApi->backofficeInviteResend: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeInviteShow

show backoffice_invite

Retrieve backoffice user invite with given code.


/0.0.1/backoffice/invites/by_code/{id}

Usage and SDK Samples

curl -X GET "https://api.quriobot.com/0.0.1/backoffice/invites/by_code/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeInviteApi;

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

public class BackofficeInviteApiExample {

    public static void main(String[] args) {
        
        BackofficeInviteApi apiInstance = new BackofficeInviteApi();
        String id = id_example; // String | Backoffice user invite code
        try {
            Bo_user_invite result = apiInstance.backofficeInviteShow(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeInviteApi#backofficeInviteShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeInviteApi;

public class BackofficeInviteApiExample {

    public static void main(String[] args) {
        BackofficeInviteApi apiInstance = new BackofficeInviteApi();
        String id = id_example; // String | Backoffice user invite code
        try {
            Bo_user_invite result = apiInstance.backofficeInviteShow(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeInviteApi#backofficeInviteShow");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Backoffice user invite code

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

// show backoffice_invite
[apiInstance backofficeInviteShowWith:id
              completionHandler: ^(Bo_user_invite output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.BackofficeInviteApi()

var id = id_example; // {String} Backoffice user invite code

api.backofficeInviteShow(id).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeInviteShowExample
    {
        public void main()
        {
            
            var apiInstance = new BackofficeInviteApi();
            var id = id_example;  // String | Backoffice user invite code

            try
            {
                // show backoffice_invite
                Bo_user_invite result = apiInstance.backofficeInviteShow(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeInviteApi.backofficeInviteShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BackofficeInviteApi();
$id = id_example; // String | Backoffice user invite code

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

my $api_instance = WWW::SwaggerClient::BackofficeInviteApi->new();
my $id = id_example; # String | Backoffice user invite code

eval { 
    my $result = $api_instance->backofficeInviteShow(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeInviteApi->backofficeInviteShow: $@\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.BackofficeInviteApi()
id = id_example # String | Backoffice user invite code

try: 
    # show backoffice_invite
    api_response = api_instance.backoffice_invite_show(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeInviteApi->backofficeInviteShow: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Backoffice user invite code
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 404 - Not Found


BackofficeKnowledgeBase

backofficeKnowledgeBaseCreate

create backoffice_knowledge_base

Create knowledge base


/0.0.1/backoffice/knowledge_bases

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/knowledge_bases"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

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

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String organisation = organisation_example; // String | 
        KnowledgeBasePayload payload = ; // KnowledgeBasePayload | Knowledge base payload
        try {
            Knowledge_base result = apiInstance.backofficeKnowledgeBaseCreate(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseCreate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String organisation = organisation_example; // String | 
        KnowledgeBasePayload payload = ; // KnowledgeBasePayload | Knowledge base payload
        try {
            Knowledge_base result = apiInstance.backofficeKnowledgeBaseCreate(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
KnowledgeBasePayload *payload = ; // Knowledge base payload

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

// create backoffice_knowledge_base
[apiInstance backofficeKnowledgeBaseCreateWith:organisation
    payload:payload
              completionHandler: ^(Knowledge_base output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeKnowledgeBaseApi()

var organisation = organisation_example; // {String} 

var payload = ; // {KnowledgeBasePayload} Knowledge base payload

api.backofficeKnowledgeBaseCreate(organisation, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeKnowledgeBaseCreateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeKnowledgeBaseApi();
            var organisation = organisation_example;  // String | 
            var payload = new KnowledgeBasePayload(); // KnowledgeBasePayload | Knowledge base payload

            try
            {
                // create backoffice_knowledge_base
                Knowledge_base result = apiInstance.backofficeKnowledgeBaseCreate(organisation, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeKnowledgeBaseApi.backofficeKnowledgeBaseCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeKnowledgeBaseApi();
$organisation = organisation_example; // String | 
$payload = ; // KnowledgeBasePayload | Knowledge base payload

try {
    $result = $api_instance->backofficeKnowledgeBaseCreate($organisation, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeKnowledgeBaseApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeKnowledgeBaseApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::KnowledgeBasePayload->new(); # KnowledgeBasePayload | Knowledge base payload

eval { 
    my $result = $api_instance->backofficeKnowledgeBaseCreate(organisation => $organisation, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseCreate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeKnowledgeBaseApi()
organisation = organisation_example # String | 
payload =  # KnowledgeBasePayload | Knowledge base payload

try: 
    # create backoffice_knowledge_base
    api_response = api_instance.backoffice_knowledge_base_create(organisation, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseCreate: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeKnowledgeBaseCreateArticle

create_article backoffice_knowledge_base

Create knowledge base article.


/0.0.1/backoffice/knowledge_bases/{id}/articles

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/knowledge_bases/{id}/articles"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

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

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String id = id_example; // String | Knowledge base ID
        String organisation = organisation_example; // String | 
        KnowledgeBaseArticlePayload payload = ; // KnowledgeBaseArticlePayload | Knowledge base article payload
        try {
            Knowledge_base_article result = apiInstance.backofficeKnowledgeBaseCreateArticle(id, organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseCreateArticle");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String id = id_example; // String | Knowledge base ID
        String organisation = organisation_example; // String | 
        KnowledgeBaseArticlePayload payload = ; // KnowledgeBaseArticlePayload | Knowledge base article payload
        try {
            Knowledge_base_article result = apiInstance.backofficeKnowledgeBaseCreateArticle(id, organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseCreateArticle");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Knowledge base ID
String *organisation = organisation_example; // 
KnowledgeBaseArticlePayload *payload = ; // Knowledge base article payload

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

// create_article backoffice_knowledge_base
[apiInstance backofficeKnowledgeBaseCreateArticleWith:id
    organisation:organisation
    payload:payload
              completionHandler: ^(Knowledge_base_article output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeKnowledgeBaseApi()

var id = id_example; // {String} Knowledge base ID

var organisation = organisation_example; // {String} 

var payload = ; // {KnowledgeBaseArticlePayload} Knowledge base article payload

api.backofficeKnowledgeBaseCreateArticle(id, organisation, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeKnowledgeBaseCreateArticleExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeKnowledgeBaseApi();
            var id = id_example;  // String | Knowledge base ID
            var organisation = organisation_example;  // String | 
            var payload = new KnowledgeBaseArticlePayload(); // KnowledgeBaseArticlePayload | Knowledge base article payload

            try
            {
                // create_article backoffice_knowledge_base
                Knowledge_base_article result = apiInstance.backofficeKnowledgeBaseCreateArticle(id, organisation, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeKnowledgeBaseApi.backofficeKnowledgeBaseCreateArticle: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeKnowledgeBaseApi();
$id = id_example; // String | Knowledge base ID
$organisation = organisation_example; // String | 
$payload = ; // KnowledgeBaseArticlePayload | Knowledge base article payload

try {
    $result = $api_instance->backofficeKnowledgeBaseCreateArticle($id, $organisation, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseCreateArticle: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeKnowledgeBaseApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeKnowledgeBaseApi->new();
my $id = id_example; # String | Knowledge base ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::KnowledgeBaseArticlePayload->new(); # KnowledgeBaseArticlePayload | Knowledge base article payload

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeKnowledgeBaseApi()
id = id_example # String | Knowledge base ID
organisation = organisation_example # String | 
payload =  # KnowledgeBaseArticlePayload | Knowledge base article payload

try: 
    # create_article backoffice_knowledge_base
    api_response = api_instance.backoffice_knowledge_base_create_article(id, organisation, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseCreateArticle: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Knowledge base ID
Required
Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeKnowledgeBaseCreateImport

create_import backoffice_knowledge_base

Create knowledge base import.


/0.0.1/backoffice/knowledge_bases/{id}/imports

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/knowledge_bases/{id}/imports"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

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

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String id = id_example; // String | Knowledge base ID
        String organisation = organisation_example; // String | 
        KnowledgeBaseImportPayload payload = ; // KnowledgeBaseImportPayload | Knowledge base import payload
        try {
            Knowledge_base_import result = apiInstance.backofficeKnowledgeBaseCreateImport(id, organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseCreateImport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String id = id_example; // String | Knowledge base ID
        String organisation = organisation_example; // String | 
        KnowledgeBaseImportPayload payload = ; // KnowledgeBaseImportPayload | Knowledge base import payload
        try {
            Knowledge_base_import result = apiInstance.backofficeKnowledgeBaseCreateImport(id, organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseCreateImport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Knowledge base ID
String *organisation = organisation_example; // 
KnowledgeBaseImportPayload *payload = ; // Knowledge base import payload

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

// create_import backoffice_knowledge_base
[apiInstance backofficeKnowledgeBaseCreateImportWith:id
    organisation:organisation
    payload:payload
              completionHandler: ^(Knowledge_base_import output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeKnowledgeBaseApi()

var id = id_example; // {String} Knowledge base ID

var organisation = organisation_example; // {String} 

var payload = ; // {KnowledgeBaseImportPayload} Knowledge base import payload

api.backofficeKnowledgeBaseCreateImport(id, organisation, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeKnowledgeBaseCreateImportExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeKnowledgeBaseApi();
            var id = id_example;  // String | Knowledge base ID
            var organisation = organisation_example;  // String | 
            var payload = new KnowledgeBaseImportPayload(); // KnowledgeBaseImportPayload | Knowledge base import payload

            try
            {
                // create_import backoffice_knowledge_base
                Knowledge_base_import result = apiInstance.backofficeKnowledgeBaseCreateImport(id, organisation, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeKnowledgeBaseApi.backofficeKnowledgeBaseCreateImport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeKnowledgeBaseApi();
$id = id_example; // String | Knowledge base ID
$organisation = organisation_example; // String | 
$payload = ; // KnowledgeBaseImportPayload | Knowledge base import payload

try {
    $result = $api_instance->backofficeKnowledgeBaseCreateImport($id, $organisation, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseCreateImport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeKnowledgeBaseApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeKnowledgeBaseApi->new();
my $id = id_example; # String | Knowledge base ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::KnowledgeBaseImportPayload->new(); # KnowledgeBaseImportPayload | Knowledge base import payload

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeKnowledgeBaseApi()
id = id_example # String | Knowledge base ID
organisation = organisation_example # String | 
payload =  # KnowledgeBaseImportPayload | Knowledge base import payload

try: 
    # create_import backoffice_knowledge_base
    api_response = api_instance.backoffice_knowledge_base_create_import(id, organisation, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseCreateImport: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Knowledge base ID
Required
Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeKnowledgeBaseDelete

delete backoffice_knowledge_base


/0.0.1/backoffice/knowledge_bases/{id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/knowledge_bases/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

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

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String id = id_example; // String | Knowledge base ID
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeKnowledgeBaseDelete(id, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String id = id_example; // String | Knowledge base ID
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeKnowledgeBaseDelete(id, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Knowledge base ID
String *organisation = organisation_example; // 

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

// delete backoffice_knowledge_base
[apiInstance backofficeKnowledgeBaseDeleteWith:id
    organisation:organisation
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeKnowledgeBaseApi()

var id = id_example; // {String} Knowledge base ID

var organisation = organisation_example; // {String} 

api.backofficeKnowledgeBaseDelete(id, organisation).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeKnowledgeBaseDeleteExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeKnowledgeBaseApi();
            var id = id_example;  // String | Knowledge base ID
            var organisation = organisation_example;  // String | 

            try
            {
                // delete backoffice_knowledge_base
                apiInstance.backofficeKnowledgeBaseDelete(id, organisation);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeKnowledgeBaseApi.backofficeKnowledgeBaseDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeKnowledgeBaseApi();
$id = id_example; // String | Knowledge base ID
$organisation = organisation_example; // String | 

try {
    $api_instance->backofficeKnowledgeBaseDelete($id, $organisation);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeKnowledgeBaseApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeKnowledgeBaseApi->new();
my $id = id_example; # String | Knowledge base ID
my $organisation = organisation_example; # String | 

eval { 
    $api_instance->backofficeKnowledgeBaseDelete(id => $id, organisation => $organisation);
};
if ($@) {
    warn "Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeKnowledgeBaseApi()
id = id_example # String | Knowledge base ID
organisation = organisation_example # String | 

try: 
    # delete backoffice_knowledge_base
    api_instance.backoffice_knowledge_base_delete(id, organisation)
except ApiException as e:
    print("Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseDelete: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Knowledge base ID
Required
Header parameters
Name Description
Organisation*
String
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeKnowledgeBaseDeleteArticle

delete_article backoffice_knowledge_base

Delete knowledge base article.


/0.0.1/backoffice/knowledge_bases/{id}/articles

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/knowledge_bases/{id}/articles"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

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

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String id = id_example; // String | Knowledge base ID
        String organisation = organisation_example; // String | 
        KnowledgeBaseArticleDeletePayload payload = ; // KnowledgeBaseArticleDeletePayload | Knowledge base article delete payload
        try {
            apiInstance.backofficeKnowledgeBaseDeleteArticle(id, organisation, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseDeleteArticle");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String id = id_example; // String | Knowledge base ID
        String organisation = organisation_example; // String | 
        KnowledgeBaseArticleDeletePayload payload = ; // KnowledgeBaseArticleDeletePayload | Knowledge base article delete payload
        try {
            apiInstance.backofficeKnowledgeBaseDeleteArticle(id, organisation, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseDeleteArticle");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Knowledge base ID
String *organisation = organisation_example; // 
KnowledgeBaseArticleDeletePayload *payload = ; // Knowledge base article delete payload

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

// delete_article backoffice_knowledge_base
[apiInstance backofficeKnowledgeBaseDeleteArticleWith:id
    organisation:organisation
    payload:payload
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeKnowledgeBaseApi()

var id = id_example; // {String} Knowledge base ID

var organisation = organisation_example; // {String} 

var payload = ; // {KnowledgeBaseArticleDeletePayload} Knowledge base article delete payload

api.backofficeKnowledgeBaseDeleteArticle(id, organisation, payload).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeKnowledgeBaseDeleteArticleExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeKnowledgeBaseApi();
            var id = id_example;  // String | Knowledge base ID
            var organisation = organisation_example;  // String | 
            var payload = new KnowledgeBaseArticleDeletePayload(); // KnowledgeBaseArticleDeletePayload | Knowledge base article delete payload

            try
            {
                // delete_article backoffice_knowledge_base
                apiInstance.backofficeKnowledgeBaseDeleteArticle(id, organisation, payload);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeKnowledgeBaseApi.backofficeKnowledgeBaseDeleteArticle: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeKnowledgeBaseApi();
$id = id_example; // String | Knowledge base ID
$organisation = organisation_example; // String | 
$payload = ; // KnowledgeBaseArticleDeletePayload | Knowledge base article delete payload

try {
    $api_instance->backofficeKnowledgeBaseDeleteArticle($id, $organisation, $payload);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseDeleteArticle: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeKnowledgeBaseApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeKnowledgeBaseApi->new();
my $id = id_example; # String | Knowledge base ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::KnowledgeBaseArticleDeletePayload->new(); # KnowledgeBaseArticleDeletePayload | Knowledge base article delete payload

eval { 
    $api_instance->backofficeKnowledgeBaseDeleteArticle(id => $id, organisation => $organisation, payload => $payload);
};
if ($@) {
    warn "Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseDeleteArticle: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeKnowledgeBaseApi()
id = id_example # String | Knowledge base ID
organisation = organisation_example # String | 
payload =  # KnowledgeBaseArticleDeletePayload | Knowledge base article delete payload

try: 
    # delete_article backoffice_knowledge_base
    api_instance.backoffice_knowledge_base_delete_article(id, organisation, payload)
except ApiException as e:
    print("Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseDeleteArticle: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Knowledge base ID
Required
Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeKnowledgeBaseList

list backoffice_knowledge_base

Retrieve all knowledge bases.


/0.0.1/backoffice/knowledge_bases/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/knowledge_bases/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

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

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String organisation = organisation_example; // String | 
        KnowledgeBaseCollectionPayload payload = ; // KnowledgeBaseCollectionPayload | Knowledge base collection payload
        try {
            Knowledge_base_collection result = apiInstance.backofficeKnowledgeBaseList(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String organisation = organisation_example; // String | 
        KnowledgeBaseCollectionPayload payload = ; // KnowledgeBaseCollectionPayload | Knowledge base collection payload
        try {
            Knowledge_base_collection result = apiInstance.backofficeKnowledgeBaseList(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
KnowledgeBaseCollectionPayload *payload = ; // Knowledge base collection payload

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

// list backoffice_knowledge_base
[apiInstance backofficeKnowledgeBaseListWith:organisation
    payload:payload
              completionHandler: ^(Knowledge_base_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeKnowledgeBaseApi()

var organisation = organisation_example; // {String} 

var payload = ; // {KnowledgeBaseCollectionPayload} Knowledge base collection payload

api.backofficeKnowledgeBaseList(organisation, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeKnowledgeBaseListExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeKnowledgeBaseApi();
            var organisation = organisation_example;  // String | 
            var payload = new KnowledgeBaseCollectionPayload(); // KnowledgeBaseCollectionPayload | Knowledge base collection payload

            try
            {
                // list backoffice_knowledge_base
                Knowledge_base_collection result = apiInstance.backofficeKnowledgeBaseList(organisation, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeKnowledgeBaseApi.backofficeKnowledgeBaseList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeKnowledgeBaseApi();
$organisation = organisation_example; // String | 
$payload = ; // KnowledgeBaseCollectionPayload | Knowledge base collection payload

try {
    $result = $api_instance->backofficeKnowledgeBaseList($organisation, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeKnowledgeBaseApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeKnowledgeBaseApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::KnowledgeBaseCollectionPayload->new(); # KnowledgeBaseCollectionPayload | Knowledge base collection payload

eval { 
    my $result = $api_instance->backofficeKnowledgeBaseList(organisation => $organisation, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeKnowledgeBaseApi()
organisation = organisation_example # String | 
payload =  # KnowledgeBaseCollectionPayload | Knowledge base collection payload

try: 
    # list backoffice_knowledge_base
    api_response = api_instance.backoffice_knowledge_base_list(organisation, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseList: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeKnowledgeBaseListArticle

list_article backoffice_knowledge_base

Retrieve knowledge base article.


/0.0.1/backoffice/knowledge_bases/{id}/articles/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/knowledge_bases/{id}/articles/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

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

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String id = id_example; // String | Knowledge base ID
        String organisation = organisation_example; // String | 
        KnowledgeBaseArticleCollectionPayload payload = ; // KnowledgeBaseArticleCollectionPayload | Knowledge base article collection payload
        try {
            Knowledge_base_article_collection result = apiInstance.backofficeKnowledgeBaseListArticle(id, organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseListArticle");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String id = id_example; // String | Knowledge base ID
        String organisation = organisation_example; // String | 
        KnowledgeBaseArticleCollectionPayload payload = ; // KnowledgeBaseArticleCollectionPayload | Knowledge base article collection payload
        try {
            Knowledge_base_article_collection result = apiInstance.backofficeKnowledgeBaseListArticle(id, organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseListArticle");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Knowledge base ID
String *organisation = organisation_example; // 
KnowledgeBaseArticleCollectionPayload *payload = ; // Knowledge base article collection payload

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

// list_article backoffice_knowledge_base
[apiInstance backofficeKnowledgeBaseListArticleWith:id
    organisation:organisation
    payload:payload
              completionHandler: ^(Knowledge_base_article_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeKnowledgeBaseApi()

var id = id_example; // {String} Knowledge base ID

var organisation = organisation_example; // {String} 

var payload = ; // {KnowledgeBaseArticleCollectionPayload} Knowledge base article collection payload

api.backofficeKnowledgeBaseListArticle(id, organisation, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeKnowledgeBaseListArticleExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeKnowledgeBaseApi();
            var id = id_example;  // String | Knowledge base ID
            var organisation = organisation_example;  // String | 
            var payload = new KnowledgeBaseArticleCollectionPayload(); // KnowledgeBaseArticleCollectionPayload | Knowledge base article collection payload

            try
            {
                // list_article backoffice_knowledge_base
                Knowledge_base_article_collection result = apiInstance.backofficeKnowledgeBaseListArticle(id, organisation, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeKnowledgeBaseApi.backofficeKnowledgeBaseListArticle: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeKnowledgeBaseApi();
$id = id_example; // String | Knowledge base ID
$organisation = organisation_example; // String | 
$payload = ; // KnowledgeBaseArticleCollectionPayload | Knowledge base article collection payload

try {
    $result = $api_instance->backofficeKnowledgeBaseListArticle($id, $organisation, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseListArticle: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeKnowledgeBaseApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeKnowledgeBaseApi->new();
my $id = id_example; # String | Knowledge base ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::KnowledgeBaseArticleCollectionPayload->new(); # KnowledgeBaseArticleCollectionPayload | Knowledge base article collection payload

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeKnowledgeBaseApi()
id = id_example # String | Knowledge base ID
organisation = organisation_example # String | 
payload =  # KnowledgeBaseArticleCollectionPayload | Knowledge base article collection payload

try: 
    # list_article backoffice_knowledge_base
    api_response = api_instance.backoffice_knowledge_base_list_article(id, organisation, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseListArticle: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Knowledge base ID
Required
Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeKnowledgeBaseListImport

list_import backoffice_knowledge_base

Retrieve knowledge base import list


/0.0.1/backoffice/knowledge_bases/{id}/imports/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/knowledge_bases/{id}/imports/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

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

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String id = id_example; // String | Knowledge base ID
        String organisation = organisation_example; // String | 
        KnowledgeBaseImportCollectionPayload payload = ; // KnowledgeBaseImportCollectionPayload | Knowledge base import collection payload
        try {
            Knowledge_base_import_collection result = apiInstance.backofficeKnowledgeBaseListImport(id, organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseListImport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String id = id_example; // String | Knowledge base ID
        String organisation = organisation_example; // String | 
        KnowledgeBaseImportCollectionPayload payload = ; // KnowledgeBaseImportCollectionPayload | Knowledge base import collection payload
        try {
            Knowledge_base_import_collection result = apiInstance.backofficeKnowledgeBaseListImport(id, organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseListImport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Knowledge base ID
String *organisation = organisation_example; // 
KnowledgeBaseImportCollectionPayload *payload = ; // Knowledge base import collection payload

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

// list_import backoffice_knowledge_base
[apiInstance backofficeKnowledgeBaseListImportWith:id
    organisation:organisation
    payload:payload
              completionHandler: ^(Knowledge_base_import_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeKnowledgeBaseApi()

var id = id_example; // {String} Knowledge base ID

var organisation = organisation_example; // {String} 

var payload = ; // {KnowledgeBaseImportCollectionPayload} Knowledge base import collection payload

api.backofficeKnowledgeBaseListImport(id, organisation, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeKnowledgeBaseListImportExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeKnowledgeBaseApi();
            var id = id_example;  // String | Knowledge base ID
            var organisation = organisation_example;  // String | 
            var payload = new KnowledgeBaseImportCollectionPayload(); // KnowledgeBaseImportCollectionPayload | Knowledge base import collection payload

            try
            {
                // list_import backoffice_knowledge_base
                Knowledge_base_import_collection result = apiInstance.backofficeKnowledgeBaseListImport(id, organisation, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeKnowledgeBaseApi.backofficeKnowledgeBaseListImport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeKnowledgeBaseApi();
$id = id_example; // String | Knowledge base ID
$organisation = organisation_example; // String | 
$payload = ; // KnowledgeBaseImportCollectionPayload | Knowledge base import collection payload

try {
    $result = $api_instance->backofficeKnowledgeBaseListImport($id, $organisation, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseListImport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeKnowledgeBaseApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeKnowledgeBaseApi->new();
my $id = id_example; # String | Knowledge base ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::KnowledgeBaseImportCollectionPayload->new(); # KnowledgeBaseImportCollectionPayload | Knowledge base import collection payload

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeKnowledgeBaseApi()
id = id_example # String | Knowledge base ID
organisation = organisation_example # String | 
payload =  # KnowledgeBaseImportCollectionPayload | Knowledge base import collection payload

try: 
    # list_import backoffice_knowledge_base
    api_response = api_instance.backoffice_knowledge_base_list_import(id, organisation, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseListImport: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Knowledge base ID
Required
Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeKnowledgeBaseRedeploy

redeploy backoffice_knowledge_base

Re-deploy knowledge base


/0.0.1/backoffice/knowledge_bases/{id}/redeploy

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/knowledge_bases/{id}/redeploy"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

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

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String id = id_example; // String | Knowledge base ID
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeKnowledgeBaseRedeploy(id, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseRedeploy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String id = id_example; // String | Knowledge base ID
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeKnowledgeBaseRedeploy(id, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseRedeploy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Knowledge base ID
String *organisation = organisation_example; // 

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

// redeploy backoffice_knowledge_base
[apiInstance backofficeKnowledgeBaseRedeployWith:id
    organisation:organisation
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeKnowledgeBaseApi()

var id = id_example; // {String} Knowledge base ID

var organisation = organisation_example; // {String} 

api.backofficeKnowledgeBaseRedeploy(id, organisation).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeKnowledgeBaseRedeployExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeKnowledgeBaseApi();
            var id = id_example;  // String | Knowledge base ID
            var organisation = organisation_example;  // String | 

            try
            {
                // redeploy backoffice_knowledge_base
                apiInstance.backofficeKnowledgeBaseRedeploy(id, organisation);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeKnowledgeBaseApi.backofficeKnowledgeBaseRedeploy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeKnowledgeBaseApi();
$id = id_example; // String | Knowledge base ID
$organisation = organisation_example; // String | 

try {
    $api_instance->backofficeKnowledgeBaseRedeploy($id, $organisation);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseRedeploy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeKnowledgeBaseApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeKnowledgeBaseApi->new();
my $id = id_example; # String | Knowledge base ID
my $organisation = organisation_example; # String | 

eval { 
    $api_instance->backofficeKnowledgeBaseRedeploy(id => $id, organisation => $organisation);
};
if ($@) {
    warn "Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseRedeploy: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeKnowledgeBaseApi()
id = id_example # String | Knowledge base ID
organisation = organisation_example # String | 

try: 
    # redeploy backoffice_knowledge_base
    api_instance.backoffice_knowledge_base_redeploy(id, organisation)
except ApiException as e:
    print("Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseRedeploy: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Knowledge base ID
Required
Header parameters
Name Description
Organisation*
String
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeKnowledgeBaseReindex

reindex backoffice_knowledge_base


/0.0.1/backoffice/knowledge_bases/{id}/reindex

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/knowledge_bases/{id}/reindex"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

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

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String id = id_example; // String | Knowledge base ID
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeKnowledgeBaseReindex(id, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseReindex");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String id = id_example; // String | Knowledge base ID
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeKnowledgeBaseReindex(id, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseReindex");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Knowledge base ID
String *organisation = organisation_example; // 

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

// reindex backoffice_knowledge_base
[apiInstance backofficeKnowledgeBaseReindexWith:id
    organisation:organisation
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeKnowledgeBaseApi()

var id = id_example; // {String} Knowledge base ID

var organisation = organisation_example; // {String} 

api.backofficeKnowledgeBaseReindex(id, organisation).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeKnowledgeBaseReindexExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeKnowledgeBaseApi();
            var id = id_example;  // String | Knowledge base ID
            var organisation = organisation_example;  // String | 

            try
            {
                // reindex backoffice_knowledge_base
                apiInstance.backofficeKnowledgeBaseReindex(id, organisation);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeKnowledgeBaseApi.backofficeKnowledgeBaseReindex: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeKnowledgeBaseApi();
$id = id_example; // String | Knowledge base ID
$organisation = organisation_example; // String | 

try {
    $api_instance->backofficeKnowledgeBaseReindex($id, $organisation);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseReindex: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeKnowledgeBaseApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeKnowledgeBaseApi->new();
my $id = id_example; # String | Knowledge base ID
my $organisation = organisation_example; # String | 

eval { 
    $api_instance->backofficeKnowledgeBaseReindex(id => $id, organisation => $organisation);
};
if ($@) {
    warn "Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseReindex: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeKnowledgeBaseApi()
id = id_example # String | Knowledge base ID
organisation = organisation_example # String | 

try: 
    # reindex backoffice_knowledge_base
    api_instance.backoffice_knowledge_base_reindex(id, organisation)
except ApiException as e:
    print("Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseReindex: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Knowledge base ID
Required
Header parameters
Name Description
Organisation*
String
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeKnowledgeBaseReplaceArticle

replace_article backoffice_knowledge_base

Replace knowledge base article content.


/0.0.1/backoffice/knowledge_bases/{id}/articles/replace

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/knowledge_bases/{id}/articles/replace"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

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

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String id = id_example; // String | Knowledge base ID
        String organisation = organisation_example; // String | 
        KnowledgeBaseArticleReplacePayload payload = ; // KnowledgeBaseArticleReplacePayload | Knowledge base article replace payload
        try {
            apiInstance.backofficeKnowledgeBaseReplaceArticle(id, organisation, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseReplaceArticle");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String id = id_example; // String | Knowledge base ID
        String organisation = organisation_example; // String | 
        KnowledgeBaseArticleReplacePayload payload = ; // KnowledgeBaseArticleReplacePayload | Knowledge base article replace payload
        try {
            apiInstance.backofficeKnowledgeBaseReplaceArticle(id, organisation, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseReplaceArticle");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Knowledge base ID
String *organisation = organisation_example; // 
KnowledgeBaseArticleReplacePayload *payload = ; // Knowledge base article replace payload

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

// replace_article backoffice_knowledge_base
[apiInstance backofficeKnowledgeBaseReplaceArticleWith:id
    organisation:organisation
    payload:payload
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeKnowledgeBaseApi()

var id = id_example; // {String} Knowledge base ID

var organisation = organisation_example; // {String} 

var payload = ; // {KnowledgeBaseArticleReplacePayload} Knowledge base article replace payload

api.backofficeKnowledgeBaseReplaceArticle(id, organisation, payload).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeKnowledgeBaseReplaceArticleExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeKnowledgeBaseApi();
            var id = id_example;  // String | Knowledge base ID
            var organisation = organisation_example;  // String | 
            var payload = new KnowledgeBaseArticleReplacePayload(); // KnowledgeBaseArticleReplacePayload | Knowledge base article replace payload

            try
            {
                // replace_article backoffice_knowledge_base
                apiInstance.backofficeKnowledgeBaseReplaceArticle(id, organisation, payload);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeKnowledgeBaseApi.backofficeKnowledgeBaseReplaceArticle: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeKnowledgeBaseApi();
$id = id_example; // String | Knowledge base ID
$organisation = organisation_example; // String | 
$payload = ; // KnowledgeBaseArticleReplacePayload | Knowledge base article replace payload

try {
    $api_instance->backofficeKnowledgeBaseReplaceArticle($id, $organisation, $payload);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseReplaceArticle: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeKnowledgeBaseApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeKnowledgeBaseApi->new();
my $id = id_example; # String | Knowledge base ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::KnowledgeBaseArticleReplacePayload->new(); # KnowledgeBaseArticleReplacePayload | Knowledge base article replace payload

eval { 
    $api_instance->backofficeKnowledgeBaseReplaceArticle(id => $id, organisation => $organisation, payload => $payload);
};
if ($@) {
    warn "Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseReplaceArticle: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeKnowledgeBaseApi()
id = id_example # String | Knowledge base ID
organisation = organisation_example # String | 
payload =  # KnowledgeBaseArticleReplacePayload | Knowledge base article replace payload

try: 
    # replace_article backoffice_knowledge_base
    api_instance.backoffice_knowledge_base_replace_article(id, organisation, payload)
except ApiException as e:
    print("Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseReplaceArticle: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Knowledge base ID
Required
Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeKnowledgeBaseShow

show backoffice_knowledge_base

Get knowledge base


/0.0.1/backoffice/knowledge_bases/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/knowledge_bases/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

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

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String id = id_example; // String | Knowledge base ID
        String organisation = organisation_example; // String | 
        try {
            Knowledge_base result = apiInstance.backofficeKnowledgeBaseShow(id, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String id = id_example; // String | Knowledge base ID
        String organisation = organisation_example; // String | 
        try {
            Knowledge_base result = apiInstance.backofficeKnowledgeBaseShow(id, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Knowledge base ID
String *organisation = organisation_example; // 

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

// show backoffice_knowledge_base
[apiInstance backofficeKnowledgeBaseShowWith:id
    organisation:organisation
              completionHandler: ^(Knowledge_base output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeKnowledgeBaseApi()

var id = id_example; // {String} Knowledge base ID

var organisation = organisation_example; // {String} 

api.backofficeKnowledgeBaseShow(id, organisation).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeKnowledgeBaseShowExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeKnowledgeBaseApi();
            var id = id_example;  // String | Knowledge base ID
            var organisation = organisation_example;  // String | 

            try
            {
                // show backoffice_knowledge_base
                Knowledge_base result = apiInstance.backofficeKnowledgeBaseShow(id, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeKnowledgeBaseApi.backofficeKnowledgeBaseShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeKnowledgeBaseApi();
$id = id_example; // String | Knowledge base ID
$organisation = organisation_example; // String | 

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

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeKnowledgeBaseApi->new();
my $id = id_example; # String | Knowledge base ID
my $organisation = organisation_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeKnowledgeBaseApi()
id = id_example # String | Knowledge base ID
organisation = organisation_example # String | 

try: 
    # show backoffice_knowledge_base
    api_response = api_instance.backoffice_knowledge_base_show(id, organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseShow: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Knowledge base ID
Required
Header parameters
Name Description
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeKnowledgeBaseShowArticle

show_article backoffice_knowledge_base

Show knowledge base article.


/0.0.1/backoffice/knowledge_bases/{id}/articles/{articleID}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/knowledge_bases/{id}/articles/{articleID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

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

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String articleID = articleID_example; // String | Knowledge base article ID
        String id = id_example; // String | Knowledge base ID
        String organisation = organisation_example; // String | 
        try {
            Knowledge_base_article result = apiInstance.backofficeKnowledgeBaseShowArticle(articleID, id, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseShowArticle");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String articleID = articleID_example; // String | Knowledge base article ID
        String id = id_example; // String | Knowledge base ID
        String organisation = organisation_example; // String | 
        try {
            Knowledge_base_article result = apiInstance.backofficeKnowledgeBaseShowArticle(articleID, id, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseShowArticle");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *articleID = articleID_example; // Knowledge base article ID
String *id = id_example; // Knowledge base ID
String *organisation = organisation_example; // 

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

// show_article backoffice_knowledge_base
[apiInstance backofficeKnowledgeBaseShowArticleWith:articleID
    id:id
    organisation:organisation
              completionHandler: ^(Knowledge_base_article output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeKnowledgeBaseApi()

var articleID = articleID_example; // {String} Knowledge base article ID

var id = id_example; // {String} Knowledge base ID

var organisation = organisation_example; // {String} 

api.backofficeKnowledgeBaseShowArticle(articleID, id, organisation).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeKnowledgeBaseShowArticleExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeKnowledgeBaseApi();
            var articleID = articleID_example;  // String | Knowledge base article ID
            var id = id_example;  // String | Knowledge base ID
            var organisation = organisation_example;  // String | 

            try
            {
                // show_article backoffice_knowledge_base
                Knowledge_base_article result = apiInstance.backofficeKnowledgeBaseShowArticle(articleID, id, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeKnowledgeBaseApi.backofficeKnowledgeBaseShowArticle: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeKnowledgeBaseApi();
$articleID = articleID_example; // String | Knowledge base article ID
$id = id_example; // String | Knowledge base ID
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeKnowledgeBaseShowArticle($articleID, $id, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseShowArticle: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeKnowledgeBaseApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeKnowledgeBaseApi->new();
my $articleID = articleID_example; # String | Knowledge base article ID
my $id = id_example; # String | Knowledge base ID
my $organisation = organisation_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeKnowledgeBaseApi()
articleID = articleID_example # String | Knowledge base article ID
id = id_example # String | Knowledge base ID
organisation = organisation_example # String | 

try: 
    # show_article backoffice_knowledge_base
    api_response = api_instance.backoffice_knowledge_base_show_article(articleID, id, organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseShowArticle: %s\n" % e)

Parameters

Path parameters
Name Description
articleID*
String
Knowledge base article ID
Required
id*
String
Knowledge base ID
Required
Header parameters
Name Description
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeKnowledgeBaseShowImport

show_import backoffice_knowledge_base

Show knowledge base import.


/0.0.1/backoffice/knowledge_bases/{id}/imports/{importID}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/knowledge_bases/{id}/imports/{importID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

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

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String id = id_example; // String | Knowledge base ID
        String importID = importID_example; // String | Knowledge base import ID
        String organisation = organisation_example; // String | 
        try {
            Knowledge_base_import result = apiInstance.backofficeKnowledgeBaseShowImport(id, importID, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseShowImport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String id = id_example; // String | Knowledge base ID
        String importID = importID_example; // String | Knowledge base import ID
        String organisation = organisation_example; // String | 
        try {
            Knowledge_base_import result = apiInstance.backofficeKnowledgeBaseShowImport(id, importID, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseShowImport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Knowledge base ID
String *importID = importID_example; // Knowledge base import ID
String *organisation = organisation_example; // 

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

// show_import backoffice_knowledge_base
[apiInstance backofficeKnowledgeBaseShowImportWith:id
    importID:importID
    organisation:organisation
              completionHandler: ^(Knowledge_base_import output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeKnowledgeBaseApi()

var id = id_example; // {String} Knowledge base ID

var importID = importID_example; // {String} Knowledge base import ID

var organisation = organisation_example; // {String} 

api.backofficeKnowledgeBaseShowImport(id, importID, organisation).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeKnowledgeBaseShowImportExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeKnowledgeBaseApi();
            var id = id_example;  // String | Knowledge base ID
            var importID = importID_example;  // String | Knowledge base import ID
            var organisation = organisation_example;  // String | 

            try
            {
                // show_import backoffice_knowledge_base
                Knowledge_base_import result = apiInstance.backofficeKnowledgeBaseShowImport(id, importID, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeKnowledgeBaseApi.backofficeKnowledgeBaseShowImport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeKnowledgeBaseApi();
$id = id_example; // String | Knowledge base ID
$importID = importID_example; // String | Knowledge base import ID
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeKnowledgeBaseShowImport($id, $importID, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseShowImport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeKnowledgeBaseApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeKnowledgeBaseApi->new();
my $id = id_example; # String | Knowledge base ID
my $importID = importID_example; # String | Knowledge base import ID
my $organisation = organisation_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeKnowledgeBaseApi()
id = id_example # String | Knowledge base ID
importID = importID_example # String | Knowledge base import ID
organisation = organisation_example # String | 

try: 
    # show_import backoffice_knowledge_base
    api_response = api_instance.backoffice_knowledge_base_show_import(id, importID, organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseShowImport: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Knowledge base ID
Required
importID*
String
Knowledge base import ID
Required
Header parameters
Name Description
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeKnowledgeBaseUpdate

update backoffice_knowledge_base

Change knowledge base


/0.0.1/backoffice/knowledge_bases/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/knowledge_bases/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

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

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String id = id_example; // String | Knowledge base ID
        String organisation = organisation_example; // String | 
        KnowledgeBasePayload payload = ; // KnowledgeBasePayload | Knowledge base payload
        try {
            Knowledge_base result = apiInstance.backofficeKnowledgeBaseUpdate(id, organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String id = id_example; // String | Knowledge base ID
        String organisation = organisation_example; // String | 
        KnowledgeBasePayload payload = ; // KnowledgeBasePayload | Knowledge base payload
        try {
            Knowledge_base result = apiInstance.backofficeKnowledgeBaseUpdate(id, organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Knowledge base ID
String *organisation = organisation_example; // 
KnowledgeBasePayload *payload = ; // Knowledge base payload

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

// update backoffice_knowledge_base
[apiInstance backofficeKnowledgeBaseUpdateWith:id
    organisation:organisation
    payload:payload
              completionHandler: ^(Knowledge_base output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeKnowledgeBaseApi()

var id = id_example; // {String} Knowledge base ID

var organisation = organisation_example; // {String} 

var payload = ; // {KnowledgeBasePayload} Knowledge base payload

api.backofficeKnowledgeBaseUpdate(id, organisation, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeKnowledgeBaseUpdateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeKnowledgeBaseApi();
            var id = id_example;  // String | Knowledge base ID
            var organisation = organisation_example;  // String | 
            var payload = new KnowledgeBasePayload(); // KnowledgeBasePayload | Knowledge base payload

            try
            {
                // update backoffice_knowledge_base
                Knowledge_base result = apiInstance.backofficeKnowledgeBaseUpdate(id, organisation, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeKnowledgeBaseApi.backofficeKnowledgeBaseUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeKnowledgeBaseApi();
$id = id_example; // String | Knowledge base ID
$organisation = organisation_example; // String | 
$payload = ; // KnowledgeBasePayload | Knowledge base payload

try {
    $result = $api_instance->backofficeKnowledgeBaseUpdate($id, $organisation, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeKnowledgeBaseApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeKnowledgeBaseApi->new();
my $id = id_example; # String | Knowledge base ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::KnowledgeBasePayload->new(); # KnowledgeBasePayload | Knowledge base payload

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeKnowledgeBaseApi()
id = id_example # String | Knowledge base ID
organisation = organisation_example # String | 
payload =  # KnowledgeBasePayload | Knowledge base payload

try: 
    # update backoffice_knowledge_base
    api_response = api_instance.backoffice_knowledge_base_update(id, organisation, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Knowledge base ID
Required
Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeKnowledgeBaseUpdateArticle

update_article backoffice_knowledge_base

Update knowledge base article.


/0.0.1/backoffice/knowledge_bases/{id}/articles/{articleID}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/knowledge_bases/{id}/articles/{articleID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

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

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String articleID = articleID_example; // String | Knowledge base article ID
        String id = id_example; // String | Knowledge base ID
        String organisation = organisation_example; // String | 
        KnowledgeBaseArticlePayload payload = ; // KnowledgeBaseArticlePayload | Knowledge base article payload
        try {
            Knowledge_base_article result = apiInstance.backofficeKnowledgeBaseUpdateArticle(articleID, id, organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseUpdateArticle");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeKnowledgeBaseApi;

public class BackofficeKnowledgeBaseApiExample {

    public static void main(String[] args) {
        BackofficeKnowledgeBaseApi apiInstance = new BackofficeKnowledgeBaseApi();
        String articleID = articleID_example; // String | Knowledge base article ID
        String id = id_example; // String | Knowledge base ID
        String organisation = organisation_example; // String | 
        KnowledgeBaseArticlePayload payload = ; // KnowledgeBaseArticlePayload | Knowledge base article payload
        try {
            Knowledge_base_article result = apiInstance.backofficeKnowledgeBaseUpdateArticle(articleID, id, organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeKnowledgeBaseApi#backofficeKnowledgeBaseUpdateArticle");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *articleID = articleID_example; // Knowledge base article ID
String *id = id_example; // Knowledge base ID
String *organisation = organisation_example; // 
KnowledgeBaseArticlePayload *payload = ; // Knowledge base article payload

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

// update_article backoffice_knowledge_base
[apiInstance backofficeKnowledgeBaseUpdateArticleWith:articleID
    id:id
    organisation:organisation
    payload:payload
              completionHandler: ^(Knowledge_base_article output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeKnowledgeBaseApi()

var articleID = articleID_example; // {String} Knowledge base article ID

var id = id_example; // {String} Knowledge base ID

var organisation = organisation_example; // {String} 

var payload = ; // {KnowledgeBaseArticlePayload} Knowledge base article payload

api.backofficeKnowledgeBaseUpdateArticle(articleID, id, organisation, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeKnowledgeBaseUpdateArticleExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeKnowledgeBaseApi();
            var articleID = articleID_example;  // String | Knowledge base article ID
            var id = id_example;  // String | Knowledge base ID
            var organisation = organisation_example;  // String | 
            var payload = new KnowledgeBaseArticlePayload(); // KnowledgeBaseArticlePayload | Knowledge base article payload

            try
            {
                // update_article backoffice_knowledge_base
                Knowledge_base_article result = apiInstance.backofficeKnowledgeBaseUpdateArticle(articleID, id, organisation, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeKnowledgeBaseApi.backofficeKnowledgeBaseUpdateArticle: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeKnowledgeBaseApi();
$articleID = articleID_example; // String | Knowledge base article ID
$id = id_example; // String | Knowledge base ID
$organisation = organisation_example; // String | 
$payload = ; // KnowledgeBaseArticlePayload | Knowledge base article payload

try {
    $result = $api_instance->backofficeKnowledgeBaseUpdateArticle($articleID, $id, $organisation, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseUpdateArticle: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeKnowledgeBaseApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeKnowledgeBaseApi->new();
my $articleID = articleID_example; # String | Knowledge base article ID
my $id = id_example; # String | Knowledge base ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::KnowledgeBaseArticlePayload->new(); # KnowledgeBaseArticlePayload | Knowledge base article payload

eval { 
    my $result = $api_instance->backofficeKnowledgeBaseUpdateArticle(articleID => $articleID, id => $id, organisation => $organisation, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseUpdateArticle: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeKnowledgeBaseApi()
articleID = articleID_example # String | Knowledge base article ID
id = id_example # String | Knowledge base ID
organisation = organisation_example # String | 
payload =  # KnowledgeBaseArticlePayload | Knowledge base article payload

try: 
    # update_article backoffice_knowledge_base
    api_response = api_instance.backoffice_knowledge_base_update_article(articleID, id, organisation, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeKnowledgeBaseApi->backofficeKnowledgeBaseUpdateArticle: %s\n" % e)

Parameters

Path parameters
Name Description
articleID*
String
Knowledge base article ID
Required
id*
String
Knowledge base ID
Required
Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


BackofficeLiveChat

backofficeLiveChatAssign

assign backoffice_live_chat

Assign chat(s)


/0.0.1/backoffice/live_chats/assign

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats/assign"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatAssignPayload payload = ; // LiveChatAssignPayload | Live chat assign payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            apiInstance.backofficeLiveChatAssign(organisation, payload, acceptLanguage, bot, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatAssign");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatAssignPayload payload = ; // LiveChatAssignPayload | Live chat assign payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            apiInstance.backofficeLiveChatAssign(organisation, payload, acceptLanguage, bot, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatAssign");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
LiveChatAssignPayload *payload = ; // Live chat assign payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// assign backoffice_live_chat
[apiInstance backofficeLiveChatAssignWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatAssignPayload} Live chat assign payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatAssign(organisation, payload, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatAssignExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatAssignPayload(); // LiveChatAssignPayload | Live chat assign payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // assign backoffice_live_chat
                apiInstance.backofficeLiveChatAssign(organisation, payload, acceptLanguage, bot, fields);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatAssign: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$organisation = organisation_example; // String | 
$payload = ; // LiveChatAssignPayload | Live chat assign payload
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $api_instance->backofficeLiveChatAssign($organisation, $payload, $acceptLanguage, $bot, $fields);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatAssign: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatAssignPayload->new(); # LiveChatAssignPayload | Live chat assign payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    $api_instance->backofficeLiveChatAssign(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatAssign: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
organisation = organisation_example # String | 
payload =  # LiveChatAssignPayload | Live chat assign payload
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # assign backoffice_live_chat
    api_instance.backoffice_live_chat_assign(organisation, payload, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatAssign: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatChannelMode

channel_mode backoffice_live_chat

Change channel mode


/0.0.1/backoffice/live_chats/{id}/channel_mode

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats/{id}/channel_mode"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        LiveChatChannelModePayload payload = ; // LiveChatChannelModePayload | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat result = apiInstance.backofficeLiveChatChannelMode(id, organisation, payload, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatChannelMode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        LiveChatChannelModePayload payload = ; // LiveChatChannelModePayload | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat result = apiInstance.backofficeLiveChatChannelMode(id, organisation, payload, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatChannelMode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Chat ID
String *organisation = organisation_example; // 
LiveChatChannelModePayload *payload = ; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// channel_mode backoffice_live_chat
[apiInstance backofficeLiveChatChannelModeWith:id
    organisation:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(Live_chat output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var id = id_example; // {String} Chat ID

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatChannelModePayload} 

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatChannelMode(id, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatChannelModeExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var id = id_example;  // String | Chat ID
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatChannelModePayload(); // LiveChatChannelModePayload | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // channel_mode backoffice_live_chat
                Live_chat result = apiInstance.backofficeLiveChatChannelMode(id, organisation, payload, acceptLanguage, bot, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatChannelMode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$id = id_example; // String | Chat ID
$organisation = organisation_example; // String | 
$payload = ; // LiveChatChannelModePayload | 
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->backofficeLiveChatChannelMode($id, $organisation, $payload, $acceptLanguage, $bot, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatChannelMode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $id = id_example; # String | Chat ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatChannelModePayload->new(); # LiveChatChannelModePayload | 
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->backofficeLiveChatChannelMode(id => $id, organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatChannelMode: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
id = id_example # String | Chat ID
organisation = organisation_example # String | 
payload =  # LiveChatChannelModePayload | 
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # channel_mode backoffice_live_chat
    api_response = api_instance.backoffice_live_chat_channel_mode(id, organisation, payload, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatChannelMode: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Chat ID
Required
Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatClose

close backoffice_live_chat

Close chat(s)


/0.0.1/backoffice/live_chats/close

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats/close"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatUpdateCollectionPayload payload = ; // LiveChatUpdateCollectionPayload | Live chat update collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            apiInstance.backofficeLiveChatClose(organisation, payload, acceptLanguage, bot, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatClose");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatUpdateCollectionPayload payload = ; // LiveChatUpdateCollectionPayload | Live chat update collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            apiInstance.backofficeLiveChatClose(organisation, payload, acceptLanguage, bot, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatClose");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
LiveChatUpdateCollectionPayload *payload = ; // Live chat update collection payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// close backoffice_live_chat
[apiInstance backofficeLiveChatCloseWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatUpdateCollectionPayload} Live chat update collection payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatClose(organisation, payload, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatCloseExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatUpdateCollectionPayload(); // LiveChatUpdateCollectionPayload | Live chat update collection payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // close backoffice_live_chat
                apiInstance.backofficeLiveChatClose(organisation, payload, acceptLanguage, bot, fields);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatClose: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$organisation = organisation_example; // String | 
$payload = ; // LiveChatUpdateCollectionPayload | Live chat update collection payload
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $api_instance->backofficeLiveChatClose($organisation, $payload, $acceptLanguage, $bot, $fields);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatClose: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatUpdateCollectionPayload->new(); # LiveChatUpdateCollectionPayload | Live chat update collection payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    $api_instance->backofficeLiveChatClose(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatClose: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
organisation = organisation_example # String | 
payload =  # LiveChatUpdateCollectionPayload | Live chat update collection payload
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # close backoffice_live_chat
    api_instance.backoffice_live_chat_close(organisation, payload, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatClose: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatCreate

create backoffice_live_chat

Create chat


/0.0.1/backoffice/live_chats

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatPayload payload = ; // LiveChatPayload | Live chat payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat result = apiInstance.backofficeLiveChatCreate(organisation, payload, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatCreate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatPayload payload = ; // LiveChatPayload | Live chat payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat result = apiInstance.backofficeLiveChatCreate(organisation, payload, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
LiveChatPayload *payload = ; // Live chat payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// create backoffice_live_chat
[apiInstance backofficeLiveChatCreateWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(Live_chat output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatPayload} Live chat payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatCreate(organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatCreateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatPayload(); // LiveChatPayload | Live chat payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // create backoffice_live_chat
                Live_chat result = apiInstance.backofficeLiveChatCreate(organisation, payload, acceptLanguage, bot, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$organisation = organisation_example; // String | 
$payload = ; // LiveChatPayload | Live chat payload
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->backofficeLiveChatCreate($organisation, $payload, $acceptLanguage, $bot, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatPayload->new(); # LiveChatPayload | Live chat payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->backofficeLiveChatCreate(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatCreate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
organisation = organisation_example # String | 
payload =  # LiveChatPayload | Live chat payload
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # create backoffice_live_chat
    api_response = api_instance.backoffice_live_chat_create(organisation, payload, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatCreate: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatCreateAttachment

create_attachment backoffice_live_chat

Create chat attachment


/0.0.1/backoffice/live_chats/{id}/attachments

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats/{id}/attachments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String id = id_example; // String | 
        String organisation = organisation_example; // String | 
        LiveChatAttachmentPayload payload = ; // LiveChatAttachmentPayload | Live chat attachment payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat_attachment result = apiInstance.backofficeLiveChatCreateAttachment(id, organisation, payload, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatCreateAttachment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String id = id_example; // String | 
        String organisation = organisation_example; // String | 
        LiveChatAttachmentPayload payload = ; // LiveChatAttachmentPayload | Live chat attachment payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat_attachment result = apiInstance.backofficeLiveChatCreateAttachment(id, organisation, payload, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatCreateAttachment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // 
String *organisation = organisation_example; // 
LiveChatAttachmentPayload *payload = ; // Live chat attachment payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// create_attachment backoffice_live_chat
[apiInstance backofficeLiveChatCreateAttachmentWith:id
    organisation:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(Live_chat_attachment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var id = id_example; // {String} 

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatAttachmentPayload} Live chat attachment payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatCreateAttachment(id, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatCreateAttachmentExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var id = id_example;  // String | 
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatAttachmentPayload(); // LiveChatAttachmentPayload | Live chat attachment payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // create_attachment backoffice_live_chat
                Live_chat_attachment result = apiInstance.backofficeLiveChatCreateAttachment(id, organisation, payload, acceptLanguage, bot, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatCreateAttachment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$id = id_example; // String | 
$organisation = organisation_example; // String | 
$payload = ; // LiveChatAttachmentPayload | Live chat attachment payload
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->backofficeLiveChatCreateAttachment($id, $organisation, $payload, $acceptLanguage, $bot, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatCreateAttachment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $id = id_example; # String | 
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatAttachmentPayload->new(); # LiveChatAttachmentPayload | Live chat attachment payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->backofficeLiveChatCreateAttachment(id => $id, organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatCreateAttachment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
id = id_example # String | 
organisation = organisation_example # String | 
payload =  # LiveChatAttachmentPayload | Live chat attachment payload
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # create_attachment backoffice_live_chat
    api_response = api_instance.backoffice_live_chat_create_attachment(id, organisation, payload, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatCreateAttachment: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required
Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatCreateImport

create_import backoffice_live_chat

Create live chat import.


/0.0.1/backoffice/live_chats/imports

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats/imports"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatImportPayload payload = ; // LiveChatImportPayload | Live chat import payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat_import result = apiInstance.backofficeLiveChatCreateImport(organisation, payload, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatCreateImport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatImportPayload payload = ; // LiveChatImportPayload | Live chat import payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat_import result = apiInstance.backofficeLiveChatCreateImport(organisation, payload, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatCreateImport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
LiveChatImportPayload *payload = ; // Live chat import payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// create_import backoffice_live_chat
[apiInstance backofficeLiveChatCreateImportWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(Live_chat_import output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatImportPayload} Live chat import payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatCreateImport(organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatCreateImportExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatImportPayload(); // LiveChatImportPayload | Live chat import payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // create_import backoffice_live_chat
                Live_chat_import result = apiInstance.backofficeLiveChatCreateImport(organisation, payload, acceptLanguage, bot, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatCreateImport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$organisation = organisation_example; // String | 
$payload = ; // LiveChatImportPayload | Live chat import payload
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->backofficeLiveChatCreateImport($organisation, $payload, $acceptLanguage, $bot, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatCreateImport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatImportPayload->new(); # LiveChatImportPayload | Live chat import payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->backofficeLiveChatCreateImport(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatCreateImport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
organisation = organisation_example # String | 
payload =  # LiveChatImportPayload | Live chat import payload
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # create_import backoffice_live_chat
    api_response = api_instance.backoffice_live_chat_create_import(organisation, payload, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatCreateImport: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatCreateMessage

create_message backoffice_live_chat

Create chat message


/0.0.1/backoffice/live_chats/{id}/messages

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats/{id}/messages"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String id = id_example; // String | 
        String organisation = organisation_example; // String | 
        LiveChatMessagePayload payload = ; // LiveChatMessagePayload | Live chat message payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat_message result = apiInstance.backofficeLiveChatCreateMessage(id, organisation, payload, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatCreateMessage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String id = id_example; // String | 
        String organisation = organisation_example; // String | 
        LiveChatMessagePayload payload = ; // LiveChatMessagePayload | Live chat message payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat_message result = apiInstance.backofficeLiveChatCreateMessage(id, organisation, payload, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatCreateMessage");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // 
String *organisation = organisation_example; // 
LiveChatMessagePayload *payload = ; // Live chat message payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// create_message backoffice_live_chat
[apiInstance backofficeLiveChatCreateMessageWith:id
    organisation:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(Live_chat_message output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var id = id_example; // {String} 

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatMessagePayload} Live chat message payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatCreateMessage(id, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatCreateMessageExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var id = id_example;  // String | 
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatMessagePayload(); // LiveChatMessagePayload | Live chat message payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // create_message backoffice_live_chat
                Live_chat_message result = apiInstance.backofficeLiveChatCreateMessage(id, organisation, payload, acceptLanguage, bot, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatCreateMessage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$id = id_example; // String | 
$organisation = organisation_example; // String | 
$payload = ; // LiveChatMessagePayload | Live chat message payload
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->backofficeLiveChatCreateMessage($id, $organisation, $payload, $acceptLanguage, $bot, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatCreateMessage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $id = id_example; # String | 
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatMessagePayload->new(); # LiveChatMessagePayload | Live chat message payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->backofficeLiveChatCreateMessage(id => $id, organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatCreateMessage: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
id = id_example # String | 
organisation = organisation_example # String | 
payload =  # LiveChatMessagePayload | Live chat message payload
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # create_message backoffice_live_chat
    api_response = api_instance.backoffice_live_chat_create_message(id, organisation, payload, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatCreateMessage: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required
Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatCreateView

create_view backoffice_live_chat

Create a live chat search view.


/0.0.1/backoffice/live_chats/views

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats/views"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatSearchViewPayload payload = ; // LiveChatSearchViewPayload | Live chat search view payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat_search_view result = apiInstance.backofficeLiveChatCreateView(organisation, payload, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatCreateView");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatSearchViewPayload payload = ; // LiveChatSearchViewPayload | Live chat search view payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat_search_view result = apiInstance.backofficeLiveChatCreateView(organisation, payload, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatCreateView");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
LiveChatSearchViewPayload *payload = ; // Live chat search view payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// create_view backoffice_live_chat
[apiInstance backofficeLiveChatCreateViewWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(Live_chat_search_view output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatSearchViewPayload} Live chat search view payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatCreateView(organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatCreateViewExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatSearchViewPayload(); // LiveChatSearchViewPayload | Live chat search view payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // create_view backoffice_live_chat
                Live_chat_search_view result = apiInstance.backofficeLiveChatCreateView(organisation, payload, acceptLanguage, bot, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatCreateView: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$organisation = organisation_example; // String | 
$payload = ; // LiveChatSearchViewPayload | Live chat search view payload
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->backofficeLiveChatCreateView($organisation, $payload, $acceptLanguage, $bot, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatCreateView: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatSearchViewPayload->new(); # LiveChatSearchViewPayload | Live chat search view payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->backofficeLiveChatCreateView(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatCreateView: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
organisation = organisation_example # String | 
payload =  # LiveChatSearchViewPayload | Live chat search view payload
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # create_view backoffice_live_chat
    api_response = api_instance.backoffice_live_chat_create_view(organisation, payload, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatCreateView: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatDelete

delete backoffice_live_chat


/0.0.1/backoffice/live_chats

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatUpdateCollectionPayload payload = ; // LiveChatUpdateCollectionPayload | Live chat update collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            apiInstance.backofficeLiveChatDelete(organisation, payload, acceptLanguage, bot, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatUpdateCollectionPayload payload = ; // LiveChatUpdateCollectionPayload | Live chat update collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            apiInstance.backofficeLiveChatDelete(organisation, payload, acceptLanguage, bot, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
LiveChatUpdateCollectionPayload *payload = ; // Live chat update collection payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// delete backoffice_live_chat
[apiInstance backofficeLiveChatDeleteWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatUpdateCollectionPayload} Live chat update collection payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatDelete(organisation, payload, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatDeleteExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatUpdateCollectionPayload(); // LiveChatUpdateCollectionPayload | Live chat update collection payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // delete backoffice_live_chat
                apiInstance.backofficeLiveChatDelete(organisation, payload, acceptLanguage, bot, fields);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$organisation = organisation_example; // String | 
$payload = ; // LiveChatUpdateCollectionPayload | Live chat update collection payload
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $api_instance->backofficeLiveChatDelete($organisation, $payload, $acceptLanguage, $bot, $fields);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatUpdateCollectionPayload->new(); # LiveChatUpdateCollectionPayload | Live chat update collection payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    $api_instance->backofficeLiveChatDelete(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
organisation = organisation_example # String | 
payload =  # LiveChatUpdateCollectionPayload | Live chat update collection payload
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # delete backoffice_live_chat
    api_instance.backoffice_live_chat_delete(organisation, payload, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatDelete: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatDeleteAttachment

delete_attachment backoffice_live_chat

Delete chat attachment


/0.0.1/backoffice/live_chats/{id}/attachments/{attachment_id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats/{id}/attachments/{attachment_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String attachmentId = attachmentId_example; // String | Chat attachment ID
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            apiInstance.backofficeLiveChatDeleteAttachment(attachmentId, id, organisation, acceptLanguage, bot, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatDeleteAttachment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String attachmentId = attachmentId_example; // String | Chat attachment ID
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            apiInstance.backofficeLiveChatDeleteAttachment(attachmentId, id, organisation, acceptLanguage, bot, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatDeleteAttachment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *attachmentId = attachmentId_example; // Chat attachment ID
String *id = id_example; // Chat ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// delete_attachment backoffice_live_chat
[apiInstance backofficeLiveChatDeleteAttachmentWith:attachmentId
    id:id
    organisation:organisation
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var attachmentId = attachmentId_example; // {String} Chat attachment ID

var id = id_example; // {String} Chat ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatDeleteAttachment(attachmentId, id, organisation, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatDeleteAttachmentExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var attachmentId = attachmentId_example;  // String | Chat attachment ID
            var id = id_example;  // String | Chat ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // delete_attachment backoffice_live_chat
                apiInstance.backofficeLiveChatDeleteAttachment(attachmentId, id, organisation, acceptLanguage, bot, fields);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatDeleteAttachment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$attachmentId = attachmentId_example; // String | Chat attachment ID
$id = id_example; // String | Chat ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $api_instance->backofficeLiveChatDeleteAttachment($attachmentId, $id, $organisation, $acceptLanguage, $bot, $fields);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatDeleteAttachment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $attachmentId = attachmentId_example; # String | Chat attachment ID
my $id = id_example; # String | Chat ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    $api_instance->backofficeLiveChatDeleteAttachment(attachmentId => $attachmentId, id => $id, organisation => $organisation, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatDeleteAttachment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
attachmentId = attachmentId_example # String | Chat attachment ID
id = id_example # String | Chat ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # delete_attachment backoffice_live_chat
    api_instance.backoffice_live_chat_delete_attachment(attachmentId, id, organisation, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatDeleteAttachment: %s\n" % e)

Parameters

Path parameters
Name Description
attachment_id*
String
Chat attachment ID
Required
id*
String
Chat ID
Required
Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatDeleteView

delete_view backoffice_live_chat

Delete live chat search view.


/0.0.1/backoffice/live_chats/views/{viewID}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats/views/{viewID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String viewID = viewID_example; // String | View ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            apiInstance.backofficeLiveChatDeleteView(viewID, organisation, acceptLanguage, bot, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatDeleteView");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String viewID = viewID_example; // String | View ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            apiInstance.backofficeLiveChatDeleteView(viewID, organisation, acceptLanguage, bot, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatDeleteView");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *viewID = viewID_example; // View ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// delete_view backoffice_live_chat
[apiInstance backofficeLiveChatDeleteViewWith:viewID
    organisation:organisation
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var viewID = viewID_example; // {String} View ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatDeleteView(viewID, organisation, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatDeleteViewExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var viewID = viewID_example;  // String | View ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // delete_view backoffice_live_chat
                apiInstance.backofficeLiveChatDeleteView(viewID, organisation, acceptLanguage, bot, fields);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatDeleteView: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$viewID = viewID_example; // String | View ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $api_instance->backofficeLiveChatDeleteView($viewID, $organisation, $acceptLanguage, $bot, $fields);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatDeleteView: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $viewID = viewID_example; # String | View ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    $api_instance->backofficeLiveChatDeleteView(viewID => $viewID, organisation => $organisation, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatDeleteView: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
viewID = viewID_example # String | View ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # delete_view backoffice_live_chat
    api_instance.backoffice_live_chat_delete_view(viewID, organisation, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatDeleteView: %s\n" % e)

Parameters

Path parameters
Name Description
viewID*
String
View ID
Required
Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatHandoverToBot

handover_to_bot backoffice_live_chat

Handover chat(s) to bot


/0.0.1/backoffice/live_chats/handover_to_bot

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats/handover_to_bot"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatUpdateCollectionPayload payload = ; // LiveChatUpdateCollectionPayload | Live chat update collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            apiInstance.backofficeLiveChatHandoverToBot(organisation, payload, acceptLanguage, bot, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatHandoverToBot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatUpdateCollectionPayload payload = ; // LiveChatUpdateCollectionPayload | Live chat update collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            apiInstance.backofficeLiveChatHandoverToBot(organisation, payload, acceptLanguage, bot, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatHandoverToBot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
LiveChatUpdateCollectionPayload *payload = ; // Live chat update collection payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// handover_to_bot backoffice_live_chat
[apiInstance backofficeLiveChatHandoverToBotWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatUpdateCollectionPayload} Live chat update collection payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatHandoverToBot(organisation, payload, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatHandoverToBotExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatUpdateCollectionPayload(); // LiveChatUpdateCollectionPayload | Live chat update collection payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // handover_to_bot backoffice_live_chat
                apiInstance.backofficeLiveChatHandoverToBot(organisation, payload, acceptLanguage, bot, fields);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatHandoverToBot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$organisation = organisation_example; // String | 
$payload = ; // LiveChatUpdateCollectionPayload | Live chat update collection payload
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $api_instance->backofficeLiveChatHandoverToBot($organisation, $payload, $acceptLanguage, $bot, $fields);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatHandoverToBot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatUpdateCollectionPayload->new(); # LiveChatUpdateCollectionPayload | Live chat update collection payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    $api_instance->backofficeLiveChatHandoverToBot(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatHandoverToBot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
organisation = organisation_example # String | 
payload =  # LiveChatUpdateCollectionPayload | Live chat update collection payload
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # handover_to_bot backoffice_live_chat
    api_instance.backoffice_live_chat_handover_to_bot(organisation, payload, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatHandoverToBot: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatJoin

join backoffice_live_chat

Join chat


/0.0.1/backoffice/live_chats/{id}/join

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats/{id}/join"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Agent result = apiInstance.backofficeLiveChatJoin(id, organisation, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatJoin");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Agent result = apiInstance.backofficeLiveChatJoin(id, organisation, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatJoin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Chat ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// join backoffice_live_chat
[apiInstance backofficeLiveChatJoinWith:id
    organisation:organisation
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(Agent output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var id = id_example; // {String} Chat ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatJoin(id, organisation, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatJoinExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var id = id_example;  // String | Chat ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // join backoffice_live_chat
                Agent result = apiInstance.backofficeLiveChatJoin(id, organisation, acceptLanguage, bot, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatJoin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$id = id_example; // String | Chat ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->backofficeLiveChatJoin($id, $organisation, $acceptLanguage, $bot, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatJoin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $id = id_example; # String | Chat ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->backofficeLiveChatJoin(id => $id, organisation => $organisation, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatJoin: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
id = id_example # String | Chat ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # join backoffice_live_chat
    api_response = api_instance.backoffice_live_chat_join(id, organisation, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatJoin: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Chat ID
Required
Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatLeave

leave backoffice_live_chat

Leave chat


/0.0.1/backoffice/live_chats/{id}/leave

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats/{id}/leave"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Agent result = apiInstance.backofficeLiveChatLeave(id, organisation, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatLeave");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Agent result = apiInstance.backofficeLiveChatLeave(id, organisation, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatLeave");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Chat ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// leave backoffice_live_chat
[apiInstance backofficeLiveChatLeaveWith:id
    organisation:organisation
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(Agent output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var id = id_example; // {String} Chat ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatLeave(id, organisation, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatLeaveExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var id = id_example;  // String | Chat ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // leave backoffice_live_chat
                Agent result = apiInstance.backofficeLiveChatLeave(id, organisation, acceptLanguage, bot, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatLeave: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$id = id_example; // String | Chat ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->backofficeLiveChatLeave($id, $organisation, $acceptLanguage, $bot, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatLeave: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $id = id_example; # String | Chat ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->backofficeLiveChatLeave(id => $id, organisation => $organisation, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatLeave: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
id = id_example # String | Chat ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # leave backoffice_live_chat
    api_response = api_instance.backoffice_live_chat_leave(id, organisation, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatLeave: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Chat ID
Required
Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatList

list backoffice_live_chat

Retrieve all chats.


/0.0.1/backoffice/live_chats/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatCollectionPayload payload = ; // LiveChatCollectionPayload | Live chat collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat_collection result = apiInstance.backofficeLiveChatList(organisation, payload, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatCollectionPayload payload = ; // LiveChatCollectionPayload | Live chat collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat_collection result = apiInstance.backofficeLiveChatList(organisation, payload, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
LiveChatCollectionPayload *payload = ; // Live chat collection payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// list backoffice_live_chat
[apiInstance backofficeLiveChatListWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(Live_chat_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatCollectionPayload} Live chat collection payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatList(organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatListExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatCollectionPayload(); // LiveChatCollectionPayload | Live chat collection payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // list backoffice_live_chat
                Live_chat_collection result = apiInstance.backofficeLiveChatList(organisation, payload, acceptLanguage, bot, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$organisation = organisation_example; // String | 
$payload = ; // LiveChatCollectionPayload | Live chat collection payload
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->backofficeLiveChatList($organisation, $payload, $acceptLanguage, $bot, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatCollectionPayload->new(); # LiveChatCollectionPayload | Live chat collection payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->backofficeLiveChatList(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
organisation = organisation_example # String | 
payload =  # LiveChatCollectionPayload | Live chat collection payload
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # list backoffice_live_chat
    api_response = api_instance.backoffice_live_chat_list(organisation, payload, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatList: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeLiveChatListImport

list_import backoffice_live_chat

Retrieve live chat import list


/0.0.1/backoffice/live_chats/imports/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats/imports/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatImportCollectionPayload payload = ; // LiveChatImportCollectionPayload | Live chat import collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat_import_collection result = apiInstance.backofficeLiveChatListImport(organisation, payload, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatListImport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatImportCollectionPayload payload = ; // LiveChatImportCollectionPayload | Live chat import collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat_import_collection result = apiInstance.backofficeLiveChatListImport(organisation, payload, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatListImport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
LiveChatImportCollectionPayload *payload = ; // Live chat import collection payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// list_import backoffice_live_chat
[apiInstance backofficeLiveChatListImportWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(Live_chat_import_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatImportCollectionPayload} Live chat import collection payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatListImport(organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatListImportExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatImportCollectionPayload(); // LiveChatImportCollectionPayload | Live chat import collection payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // list_import backoffice_live_chat
                Live_chat_import_collection result = apiInstance.backofficeLiveChatListImport(organisation, payload, acceptLanguage, bot, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatListImport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$organisation = organisation_example; // String | 
$payload = ; // LiveChatImportCollectionPayload | Live chat import collection payload
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->backofficeLiveChatListImport($organisation, $payload, $acceptLanguage, $bot, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatListImport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatImportCollectionPayload->new(); # LiveChatImportCollectionPayload | Live chat import collection payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->backofficeLiveChatListImport(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatListImport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
organisation = organisation_example # String | 
payload =  # LiveChatImportCollectionPayload | Live chat import collection payload
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # list_import backoffice_live_chat
    api_response = api_instance.backoffice_live_chat_list_import(organisation, payload, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatListImport: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeLiveChatListMessages

list_messages backoffice_live_chat

List chat messages


/0.0.1/backoffice/live_chats/{id}/messages/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats/{id}/messages/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String id = id_example; // String | 
        String organisation = organisation_example; // String | 
        LiveChatMessageCollectionPayload payload = ; // LiveChatMessageCollectionPayload | Live chat message collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat_message_collection result = apiInstance.backofficeLiveChatListMessages(id, organisation, payload, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatListMessages");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String id = id_example; // String | 
        String organisation = organisation_example; // String | 
        LiveChatMessageCollectionPayload payload = ; // LiveChatMessageCollectionPayload | Live chat message collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat_message_collection result = apiInstance.backofficeLiveChatListMessages(id, organisation, payload, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatListMessages");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // 
String *organisation = organisation_example; // 
LiveChatMessageCollectionPayload *payload = ; // Live chat message collection payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// list_messages backoffice_live_chat
[apiInstance backofficeLiveChatListMessagesWith:id
    organisation:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(Live_chat_message_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var id = id_example; // {String} 

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatMessageCollectionPayload} Live chat message collection payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatListMessages(id, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatListMessagesExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var id = id_example;  // String | 
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatMessageCollectionPayload(); // LiveChatMessageCollectionPayload | Live chat message collection payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // list_messages backoffice_live_chat
                Live_chat_message_collection result = apiInstance.backofficeLiveChatListMessages(id, organisation, payload, acceptLanguage, bot, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatListMessages: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$id = id_example; // String | 
$organisation = organisation_example; // String | 
$payload = ; // LiveChatMessageCollectionPayload | Live chat message collection payload
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->backofficeLiveChatListMessages($id, $organisation, $payload, $acceptLanguage, $bot, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatListMessages: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $id = id_example; # String | 
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatMessageCollectionPayload->new(); # LiveChatMessageCollectionPayload | Live chat message collection payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->backofficeLiveChatListMessages(id => $id, organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatListMessages: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
id = id_example # String | 
organisation = organisation_example # String | 
payload =  # LiveChatMessageCollectionPayload | Live chat message collection payload
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # list_messages backoffice_live_chat
    api_response = api_instance.backoffice_live_chat_list_messages(id, organisation, payload, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatListMessages: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required
Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatListViews

list_views backoffice_live_chat

Retrieve live chat search view list


/0.0.1/backoffice/live_chats/views/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats/views/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatSearchViewCollectionPayload payload = ; // LiveChatSearchViewCollectionPayload | Live chat search view collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat_search_view_collection result = apiInstance.backofficeLiveChatListViews(organisation, payload, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatListViews");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatSearchViewCollectionPayload payload = ; // LiveChatSearchViewCollectionPayload | Live chat search view collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat_search_view_collection result = apiInstance.backofficeLiveChatListViews(organisation, payload, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatListViews");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
LiveChatSearchViewCollectionPayload *payload = ; // Live chat search view collection payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// list_views backoffice_live_chat
[apiInstance backofficeLiveChatListViewsWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(Live_chat_search_view_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatSearchViewCollectionPayload} Live chat search view collection payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatListViews(organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatListViewsExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatSearchViewCollectionPayload(); // LiveChatSearchViewCollectionPayload | Live chat search view collection payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // list_views backoffice_live_chat
                Live_chat_search_view_collection result = apiInstance.backofficeLiveChatListViews(organisation, payload, acceptLanguage, bot, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatListViews: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$organisation = organisation_example; // String | 
$payload = ; // LiveChatSearchViewCollectionPayload | Live chat search view collection payload
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->backofficeLiveChatListViews($organisation, $payload, $acceptLanguage, $bot, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatListViews: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatSearchViewCollectionPayload->new(); # LiveChatSearchViewCollectionPayload | Live chat search view collection payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->backofficeLiveChatListViews(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatListViews: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
organisation = organisation_example # String | 
payload =  # LiveChatSearchViewCollectionPayload | Live chat search view collection payload
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # list_views backoffice_live_chat
    api_response = api_instance.backoffice_live_chat_list_views(organisation, payload, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatListViews: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeLiveChatMarkSpam

mark_spam backoffice_live_chat

Mark chat(s) as spam


/0.0.1/backoffice/live_chats/mark_spam

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats/mark_spam"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatUpdateCollectionPayload payload = ; // LiveChatUpdateCollectionPayload | Live chat update collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            apiInstance.backofficeLiveChatMarkSpam(organisation, payload, acceptLanguage, bot, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatMarkSpam");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatUpdateCollectionPayload payload = ; // LiveChatUpdateCollectionPayload | Live chat update collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            apiInstance.backofficeLiveChatMarkSpam(organisation, payload, acceptLanguage, bot, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatMarkSpam");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
LiveChatUpdateCollectionPayload *payload = ; // Live chat update collection payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// mark_spam backoffice_live_chat
[apiInstance backofficeLiveChatMarkSpamWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatUpdateCollectionPayload} Live chat update collection payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatMarkSpam(organisation, payload, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatMarkSpamExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatUpdateCollectionPayload(); // LiveChatUpdateCollectionPayload | Live chat update collection payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // mark_spam backoffice_live_chat
                apiInstance.backofficeLiveChatMarkSpam(organisation, payload, acceptLanguage, bot, fields);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatMarkSpam: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$organisation = organisation_example; // String | 
$payload = ; // LiveChatUpdateCollectionPayload | Live chat update collection payload
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $api_instance->backofficeLiveChatMarkSpam($organisation, $payload, $acceptLanguage, $bot, $fields);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatMarkSpam: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatUpdateCollectionPayload->new(); # LiveChatUpdateCollectionPayload | Live chat update collection payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    $api_instance->backofficeLiveChatMarkSpam(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatMarkSpam: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
organisation = organisation_example # String | 
payload =  # LiveChatUpdateCollectionPayload | Live chat update collection payload
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # mark_spam backoffice_live_chat
    api_instance.backoffice_live_chat_mark_spam(organisation, payload, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatMarkSpam: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatMerge

merge backoffice_live_chat

Merge chats


/0.0.1/backoffice/live_chats/merge

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats/merge"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatMergePayload payload = ; // LiveChatMergePayload | Live chat merge payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            apiInstance.backofficeLiveChatMerge(organisation, payload, acceptLanguage, bot, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatMerge");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatMergePayload payload = ; // LiveChatMergePayload | Live chat merge payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            apiInstance.backofficeLiveChatMerge(organisation, payload, acceptLanguage, bot, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatMerge");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
LiveChatMergePayload *payload = ; // Live chat merge payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// merge backoffice_live_chat
[apiInstance backofficeLiveChatMergeWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatMergePayload} Live chat merge payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatMerge(organisation, payload, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatMergeExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatMergePayload(); // LiveChatMergePayload | Live chat merge payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // merge backoffice_live_chat
                apiInstance.backofficeLiveChatMerge(organisation, payload, acceptLanguage, bot, fields);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatMerge: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$organisation = organisation_example; // String | 
$payload = ; // LiveChatMergePayload | Live chat merge payload
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $api_instance->backofficeLiveChatMerge($organisation, $payload, $acceptLanguage, $bot, $fields);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatMerge: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatMergePayload->new(); # LiveChatMergePayload | Live chat merge payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    $api_instance->backofficeLiveChatMerge(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatMerge: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
organisation = organisation_example # String | 
payload =  # LiveChatMergePayload | Live chat merge payload
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # merge backoffice_live_chat
    api_instance.backoffice_live_chat_merge(organisation, payload, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatMerge: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatReopen

reopen backoffice_live_chat

Reopen chat(s)


/0.0.1/backoffice/live_chats/reopen

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats/reopen"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatUpdateCollectionPayload payload = ; // LiveChatUpdateCollectionPayload | Live chat update collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            apiInstance.backofficeLiveChatReopen(organisation, payload, acceptLanguage, bot, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatReopen");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatUpdateCollectionPayload payload = ; // LiveChatUpdateCollectionPayload | Live chat update collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            apiInstance.backofficeLiveChatReopen(organisation, payload, acceptLanguage, bot, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatReopen");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
LiveChatUpdateCollectionPayload *payload = ; // Live chat update collection payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// reopen backoffice_live_chat
[apiInstance backofficeLiveChatReopenWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatUpdateCollectionPayload} Live chat update collection payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatReopen(organisation, payload, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatReopenExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatUpdateCollectionPayload(); // LiveChatUpdateCollectionPayload | Live chat update collection payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // reopen backoffice_live_chat
                apiInstance.backofficeLiveChatReopen(organisation, payload, acceptLanguage, bot, fields);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatReopen: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$organisation = organisation_example; // String | 
$payload = ; // LiveChatUpdateCollectionPayload | Live chat update collection payload
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $api_instance->backofficeLiveChatReopen($organisation, $payload, $acceptLanguage, $bot, $fields);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatReopen: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatUpdateCollectionPayload->new(); # LiveChatUpdateCollectionPayload | Live chat update collection payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    $api_instance->backofficeLiveChatReopen(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatReopen: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
organisation = organisation_example # String | 
payload =  # LiveChatUpdateCollectionPayload | Live chat update collection payload
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # reopen backoffice_live_chat
    api_instance.backoffice_live_chat_reopen(organisation, payload, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatReopen: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatShow

show backoffice_live_chat

Show chat


/0.0.1/backoffice/live_chats/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat result = apiInstance.backofficeLiveChatShow(id, organisation, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat result = apiInstance.backofficeLiveChatShow(id, organisation, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Chat ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// show backoffice_live_chat
[apiInstance backofficeLiveChatShowWith:id
    organisation:organisation
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(Live_chat output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var id = id_example; // {String} Chat ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatShow(id, organisation, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatShowExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var id = id_example;  // String | Chat ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // show backoffice_live_chat
                Live_chat result = apiInstance.backofficeLiveChatShow(id, organisation, acceptLanguage, bot, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$id = id_example; // String | Chat ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->backofficeLiveChatShow($id, $organisation, $acceptLanguage, $bot, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatShow: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $id = id_example; # String | Chat ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->backofficeLiveChatShow(id => $id, organisation => $organisation, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatShow: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
id = id_example # String | Chat ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # show backoffice_live_chat
    api_response = api_instance.backoffice_live_chat_show(id, organisation, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatShow: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Chat ID
Required
Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatShowAttachment

show_attachment backoffice_live_chat

Show chat attachment


/0.0.1/backoffice/live_chats/{id}/attachments/{attachment_id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats/{id}/attachments/{attachment_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String attachmentId = attachmentId_example; // String | Chat attachment ID
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat_attachment result = apiInstance.backofficeLiveChatShowAttachment(attachmentId, id, organisation, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatShowAttachment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String attachmentId = attachmentId_example; // String | Chat attachment ID
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat_attachment result = apiInstance.backofficeLiveChatShowAttachment(attachmentId, id, organisation, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatShowAttachment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *attachmentId = attachmentId_example; // Chat attachment ID
String *id = id_example; // Chat ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// show_attachment backoffice_live_chat
[apiInstance backofficeLiveChatShowAttachmentWith:attachmentId
    id:id
    organisation:organisation
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(Live_chat_attachment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var attachmentId = attachmentId_example; // {String} Chat attachment ID

var id = id_example; // {String} Chat ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatShowAttachment(attachmentId, id, organisation, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatShowAttachmentExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var attachmentId = attachmentId_example;  // String | Chat attachment ID
            var id = id_example;  // String | Chat ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // show_attachment backoffice_live_chat
                Live_chat_attachment result = apiInstance.backofficeLiveChatShowAttachment(attachmentId, id, organisation, acceptLanguage, bot, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatShowAttachment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$attachmentId = attachmentId_example; // String | Chat attachment ID
$id = id_example; // String | Chat ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->backofficeLiveChatShowAttachment($attachmentId, $id, $organisation, $acceptLanguage, $bot, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatShowAttachment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $attachmentId = attachmentId_example; # String | Chat attachment ID
my $id = id_example; # String | Chat ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->backofficeLiveChatShowAttachment(attachmentId => $attachmentId, id => $id, organisation => $organisation, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatShowAttachment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
attachmentId = attachmentId_example # String | Chat attachment ID
id = id_example # String | Chat ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # show_attachment backoffice_live_chat
    api_response = api_instance.backoffice_live_chat_show_attachment(attachmentId, id, organisation, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatShowAttachment: %s\n" % e)

Parameters

Path parameters
Name Description
attachment_id*
String
Chat attachment ID
Required
id*
String
Chat ID
Required
Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatShowImport

show_import backoffice_live_chat

Show live chat import.


/0.0.1/backoffice/live_chats/imports/{importID}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats/imports/{importID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String importID = importID_example; // String | Import ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat_import result = apiInstance.backofficeLiveChatShowImport(importID, organisation, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatShowImport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String importID = importID_example; // String | Import ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat_import result = apiInstance.backofficeLiveChatShowImport(importID, organisation, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatShowImport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *importID = importID_example; // Import ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// show_import backoffice_live_chat
[apiInstance backofficeLiveChatShowImportWith:importID
    organisation:organisation
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(Live_chat_import output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var importID = importID_example; // {String} Import ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatShowImport(importID, organisation, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatShowImportExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var importID = importID_example;  // String | Import ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // show_import backoffice_live_chat
                Live_chat_import result = apiInstance.backofficeLiveChatShowImport(importID, organisation, acceptLanguage, bot, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatShowImport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$importID = importID_example; // String | Import ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->backofficeLiveChatShowImport($importID, $organisation, $acceptLanguage, $bot, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatShowImport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $importID = importID_example; # String | Import ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->backofficeLiveChatShowImport(importID => $importID, organisation => $organisation, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatShowImport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
importID = importID_example # String | Import ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # show_import backoffice_live_chat
    api_response = api_instance.backoffice_live_chat_show_import(importID, organisation, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatShowImport: %s\n" % e)

Parameters

Path parameters
Name Description
importID*
String
Import ID
Required
Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatShowMessage

show_message backoffice_live_chat

Show chat message


/0.0.1/backoffice/live_chats/{id}/messages/{message_id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats/{id}/messages/{message_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String id = id_example; // String | Chat ID
        String messageId = messageId_example; // String | Chat message ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat_message result = apiInstance.backofficeLiveChatShowMessage(id, messageId, organisation, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatShowMessage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String id = id_example; // String | Chat ID
        String messageId = messageId_example; // String | Chat message ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat_message result = apiInstance.backofficeLiveChatShowMessage(id, messageId, organisation, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatShowMessage");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Chat ID
String *messageId = messageId_example; // Chat message ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// show_message backoffice_live_chat
[apiInstance backofficeLiveChatShowMessageWith:id
    messageId:messageId
    organisation:organisation
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(Live_chat_message output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var id = id_example; // {String} Chat ID

var messageId = messageId_example; // {String} Chat message ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatShowMessage(id, messageId, organisation, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatShowMessageExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var id = id_example;  // String | Chat ID
            var messageId = messageId_example;  // String | Chat message ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // show_message backoffice_live_chat
                Live_chat_message result = apiInstance.backofficeLiveChatShowMessage(id, messageId, organisation, acceptLanguage, bot, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatShowMessage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$id = id_example; // String | Chat ID
$messageId = messageId_example; // String | Chat message ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->backofficeLiveChatShowMessage($id, $messageId, $organisation, $acceptLanguage, $bot, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatShowMessage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $id = id_example; # String | Chat ID
my $messageId = messageId_example; # String | Chat message ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->backofficeLiveChatShowMessage(id => $id, messageId => $messageId, organisation => $organisation, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatShowMessage: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
id = id_example # String | Chat ID
messageId = messageId_example # String | Chat message ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # show_message backoffice_live_chat
    api_response = api_instance.backoffice_live_chat_show_message(id, messageId, organisation, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatShowMessage: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Chat ID
Required
message_id*
String
Chat message ID
Required
Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatShowView

show_view backoffice_live_chat

Show live chat search view.


/0.0.1/backoffice/live_chats/views/{viewID}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats/views/{viewID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String viewID = viewID_example; // String | View ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat_search_view result = apiInstance.backofficeLiveChatShowView(viewID, organisation, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatShowView");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String viewID = viewID_example; // String | View ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat_search_view result = apiInstance.backofficeLiveChatShowView(viewID, organisation, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatShowView");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *viewID = viewID_example; // View ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// show_view backoffice_live_chat
[apiInstance backofficeLiveChatShowViewWith:viewID
    organisation:organisation
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(Live_chat_search_view output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var viewID = viewID_example; // {String} View ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatShowView(viewID, organisation, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatShowViewExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var viewID = viewID_example;  // String | View ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // show_view backoffice_live_chat
                Live_chat_search_view result = apiInstance.backofficeLiveChatShowView(viewID, organisation, acceptLanguage, bot, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatShowView: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$viewID = viewID_example; // String | View ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->backofficeLiveChatShowView($viewID, $organisation, $acceptLanguage, $bot, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatShowView: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $viewID = viewID_example; # String | View ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->backofficeLiveChatShowView(viewID => $viewID, organisation => $organisation, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatShowView: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
viewID = viewID_example # String | View ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # show_view backoffice_live_chat
    api_response = api_instance.backoffice_live_chat_show_view(viewID, organisation, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatShowView: %s\n" % e)

Parameters

Path parameters
Name Description
viewID*
String
View ID
Required
Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatTranslationMode

translation_mode backoffice_live_chat

Change translation mode


/0.0.1/backoffice/live_chats/{id}/translation_mode

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats/{id}/translation_mode"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        LiveChatTranslationModePayload payload = ; // LiveChatTranslationModePayload | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat result = apiInstance.backofficeLiveChatTranslationMode(id, organisation, payload, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatTranslationMode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        LiveChatTranslationModePayload payload = ; // LiveChatTranslationModePayload | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat result = apiInstance.backofficeLiveChatTranslationMode(id, organisation, payload, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatTranslationMode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Chat ID
String *organisation = organisation_example; // 
LiveChatTranslationModePayload *payload = ; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// translation_mode backoffice_live_chat
[apiInstance backofficeLiveChatTranslationModeWith:id
    organisation:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(Live_chat output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var id = id_example; // {String} Chat ID

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatTranslationModePayload} 

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatTranslationMode(id, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatTranslationModeExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var id = id_example;  // String | Chat ID
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatTranslationModePayload(); // LiveChatTranslationModePayload | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // translation_mode backoffice_live_chat
                Live_chat result = apiInstance.backofficeLiveChatTranslationMode(id, organisation, payload, acceptLanguage, bot, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatTranslationMode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$id = id_example; // String | Chat ID
$organisation = organisation_example; // String | 
$payload = ; // LiveChatTranslationModePayload | 
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->backofficeLiveChatTranslationMode($id, $organisation, $payload, $acceptLanguage, $bot, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatTranslationMode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $id = id_example; # String | Chat ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatTranslationModePayload->new(); # LiveChatTranslationModePayload | 
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->backofficeLiveChatTranslationMode(id => $id, organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatTranslationMode: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
id = id_example # String | Chat ID
organisation = organisation_example # String | 
payload =  # LiveChatTranslationModePayload | 
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # translation_mode backoffice_live_chat
    api_response = api_instance.backoffice_live_chat_translation_mode(id, organisation, payload, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatTranslationMode: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Chat ID
Required
Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatUnmarkSpam

unmark_spam backoffice_live_chat

Mark chat(s) as spam


/0.0.1/backoffice/live_chats/unmark_spam

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats/unmark_spam"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatUpdateCollectionPayload payload = ; // LiveChatUpdateCollectionPayload | Live chat update collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            apiInstance.backofficeLiveChatUnmarkSpam(organisation, payload, acceptLanguage, bot, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatUnmarkSpam");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatUpdateCollectionPayload payload = ; // LiveChatUpdateCollectionPayload | Live chat update collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            apiInstance.backofficeLiveChatUnmarkSpam(organisation, payload, acceptLanguage, bot, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatUnmarkSpam");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
LiveChatUpdateCollectionPayload *payload = ; // Live chat update collection payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// unmark_spam backoffice_live_chat
[apiInstance backofficeLiveChatUnmarkSpamWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatUpdateCollectionPayload} Live chat update collection payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatUnmarkSpam(organisation, payload, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatUnmarkSpamExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatUpdateCollectionPayload(); // LiveChatUpdateCollectionPayload | Live chat update collection payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // unmark_spam backoffice_live_chat
                apiInstance.backofficeLiveChatUnmarkSpam(organisation, payload, acceptLanguage, bot, fields);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatUnmarkSpam: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$organisation = organisation_example; // String | 
$payload = ; // LiveChatUpdateCollectionPayload | Live chat update collection payload
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $api_instance->backofficeLiveChatUnmarkSpam($organisation, $payload, $acceptLanguage, $bot, $fields);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatUnmarkSpam: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatUpdateCollectionPayload->new(); # LiveChatUpdateCollectionPayload | Live chat update collection payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    $api_instance->backofficeLiveChatUnmarkSpam(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatUnmarkSpam: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
organisation = organisation_example # String | 
payload =  # LiveChatUpdateCollectionPayload | Live chat update collection payload
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # unmark_spam backoffice_live_chat
    api_instance.backoffice_live_chat_unmark_spam(organisation, payload, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatUnmarkSpam: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatUpdate

update backoffice_live_chat

Change chat


/0.0.1/backoffice/live_chats/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        LiveChatPayload payload = ; // LiveChatPayload | Live chat payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat result = apiInstance.backofficeLiveChatUpdate(id, organisation, payload, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        LiveChatPayload payload = ; // LiveChatPayload | Live chat payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat result = apiInstance.backofficeLiveChatUpdate(id, organisation, payload, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Chat ID
String *organisation = organisation_example; // 
LiveChatPayload *payload = ; // Live chat payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// update backoffice_live_chat
[apiInstance backofficeLiveChatUpdateWith:id
    organisation:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(Live_chat output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var id = id_example; // {String} Chat ID

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatPayload} Live chat payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatUpdate(id, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatUpdateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var id = id_example;  // String | Chat ID
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatPayload(); // LiveChatPayload | Live chat payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // update backoffice_live_chat
                Live_chat result = apiInstance.backofficeLiveChatUpdate(id, organisation, payload, acceptLanguage, bot, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$id = id_example; // String | Chat ID
$organisation = organisation_example; // String | 
$payload = ; // LiveChatPayload | Live chat payload
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->backofficeLiveChatUpdate($id, $organisation, $payload, $acceptLanguage, $bot, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $id = id_example; # String | Chat ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatPayload->new(); # LiveChatPayload | Live chat payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->backofficeLiveChatUpdate(id => $id, organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatUpdate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
id = id_example # String | Chat ID
organisation = organisation_example # String | 
payload =  # LiveChatPayload | Live chat payload
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # update backoffice_live_chat
    api_response = api_instance.backoffice_live_chat_update(id, organisation, payload, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Chat ID
Required
Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatUpdateView

update_view backoffice_live_chat

Update live chat search view.


/0.0.1/backoffice/live_chats/views/{viewID}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chats/views/{viewID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatApi;

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

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String viewID = viewID_example; // String | View ID
        String organisation = organisation_example; // String | 
        LiveChatSearchViewPayload payload = ; // LiveChatSearchViewPayload | Live chat search view payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat_search_view result = apiInstance.backofficeLiveChatUpdateView(viewID, organisation, payload, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatUpdateView");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatApi;

public class BackofficeLiveChatApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatApi apiInstance = new BackofficeLiveChatApi();
        String viewID = viewID_example; // String | View ID
        String organisation = organisation_example; // String | 
        LiveChatSearchViewPayload payload = ; // LiveChatSearchViewPayload | Live chat search view payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        try {
            Live_chat_search_view result = apiInstance.backofficeLiveChatUpdateView(viewID, organisation, payload, acceptLanguage, bot, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatApi#backofficeLiveChatUpdateView");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *viewID = viewID_example; // View ID
String *organisation = organisation_example; // 
LiveChatSearchViewPayload *payload = ; // Live chat search view payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// update_view backoffice_live_chat
[apiInstance backofficeLiveChatUpdateViewWith:viewID
    organisation:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
              completionHandler: ^(Live_chat_search_view output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatApi()

var viewID = viewID_example; // {String} View ID

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatSearchViewPayload} Live chat search view payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example // {String} 
};
api.backofficeLiveChatUpdateView(viewID, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatUpdateViewExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatApi();
            var viewID = viewID_example;  // String | View ID
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatSearchViewPayload(); // LiveChatSearchViewPayload | Live chat search view payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // update_view backoffice_live_chat
                Live_chat_search_view result = apiInstance.backofficeLiveChatUpdateView(viewID, organisation, payload, acceptLanguage, bot, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatApi.backofficeLiveChatUpdateView: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatApi();
$viewID = viewID_example; // String | View ID
$organisation = organisation_example; // String | 
$payload = ; // LiveChatSearchViewPayload | Live chat search view payload
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->backofficeLiveChatUpdateView($viewID, $organisation, $payload, $acceptLanguage, $bot, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatApi->backofficeLiveChatUpdateView: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatApi->new();
my $viewID = viewID_example; # String | View ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatSearchViewPayload->new(); # LiveChatSearchViewPayload | Live chat search view payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->backofficeLiveChatUpdateView(viewID => $viewID, organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatApi->backofficeLiveChatUpdateView: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatApi()
viewID = viewID_example # String | View ID
organisation = organisation_example # String | 
payload =  # LiveChatSearchViewPayload | Live chat search view payload
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)

try: 
    # update_view backoffice_live_chat
    api_response = api_instance.backoffice_live_chat_update_view(viewID, organisation, payload, acceptLanguage=acceptLanguage, bot=bot, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatApi->backofficeLiveChatUpdateView: %s\n" % e)

Parameters

Path parameters
Name Description
viewID*
String
View ID
Required
Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


BackofficeLiveChatCannedResponse

backofficeLiveChatCannedResponseCreate

create backoffice_live_chat_canned_response

Create canned response


/0.0.1/backoffice/live_chat_canned_responses

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chat_canned_responses"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatCannedResponseApi;

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

public class BackofficeLiveChatCannedResponseApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatCannedResponseApi apiInstance = new BackofficeLiveChatCannedResponseApi();
        String organisation = organisation_example; // String | 
        LiveChatCannedResponsePayload payload = ; // LiveChatCannedResponsePayload | Live chat canned response payload
        try {
            Live_chat_canned_response result = apiInstance.backofficeLiveChatCannedResponseCreate(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatCannedResponseApi#backofficeLiveChatCannedResponseCreate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatCannedResponseApi;

public class BackofficeLiveChatCannedResponseApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatCannedResponseApi apiInstance = new BackofficeLiveChatCannedResponseApi();
        String organisation = organisation_example; // String | 
        LiveChatCannedResponsePayload payload = ; // LiveChatCannedResponsePayload | Live chat canned response payload
        try {
            Live_chat_canned_response result = apiInstance.backofficeLiveChatCannedResponseCreate(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatCannedResponseApi#backofficeLiveChatCannedResponseCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
LiveChatCannedResponsePayload *payload = ; // Live chat canned response payload

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

// create backoffice_live_chat_canned_response
[apiInstance backofficeLiveChatCannedResponseCreateWith:organisation
    payload:payload
              completionHandler: ^(Live_chat_canned_response output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatCannedResponseApi()

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatCannedResponsePayload} Live chat canned response payload

api.backofficeLiveChatCannedResponseCreate(organisation, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatCannedResponseCreateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatCannedResponseApi();
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatCannedResponsePayload(); // LiveChatCannedResponsePayload | Live chat canned response payload

            try
            {
                // create backoffice_live_chat_canned_response
                Live_chat_canned_response result = apiInstance.backofficeLiveChatCannedResponseCreate(organisation, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatCannedResponseApi.backofficeLiveChatCannedResponseCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatCannedResponseApi();
$organisation = organisation_example; // String | 
$payload = ; // LiveChatCannedResponsePayload | Live chat canned response payload

try {
    $result = $api_instance->backofficeLiveChatCannedResponseCreate($organisation, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatCannedResponseApi->backofficeLiveChatCannedResponseCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatCannedResponseApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatCannedResponseApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatCannedResponsePayload->new(); # LiveChatCannedResponsePayload | Live chat canned response payload

eval { 
    my $result = $api_instance->backofficeLiveChatCannedResponseCreate(organisation => $organisation, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatCannedResponseApi->backofficeLiveChatCannedResponseCreate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatCannedResponseApi()
organisation = organisation_example # String | 
payload =  # LiveChatCannedResponsePayload | Live chat canned response payload

try: 
    # create backoffice_live_chat_canned_response
    api_response = api_instance.backoffice_live_chat_canned_response_create(organisation, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatCannedResponseApi->backofficeLiveChatCannedResponseCreate: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatCannedResponseDelete

delete backoffice_live_chat_canned_response


/0.0.1/backoffice/live_chat_canned_responses

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chat_canned_responses"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatCannedResponseApi;

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

public class BackofficeLiveChatCannedResponseApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatCannedResponseApi apiInstance = new BackofficeLiveChatCannedResponseApi();
        String organisation = organisation_example; // String | 
        LiveChatCannedResponseCollectionPayload payload = ; // LiveChatCannedResponseCollectionPayload | Live chat canned response collection payload
        try {
            apiInstance.backofficeLiveChatCannedResponseDelete(organisation, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatCannedResponseApi#backofficeLiveChatCannedResponseDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatCannedResponseApi;

public class BackofficeLiveChatCannedResponseApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatCannedResponseApi apiInstance = new BackofficeLiveChatCannedResponseApi();
        String organisation = organisation_example; // String | 
        LiveChatCannedResponseCollectionPayload payload = ; // LiveChatCannedResponseCollectionPayload | Live chat canned response collection payload
        try {
            apiInstance.backofficeLiveChatCannedResponseDelete(organisation, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatCannedResponseApi#backofficeLiveChatCannedResponseDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
LiveChatCannedResponseCollectionPayload *payload = ; // Live chat canned response collection payload

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

// delete backoffice_live_chat_canned_response
[apiInstance backofficeLiveChatCannedResponseDeleteWith:organisation
    payload:payload
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatCannedResponseApi()

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatCannedResponseCollectionPayload} Live chat canned response collection payload

api.backofficeLiveChatCannedResponseDelete(organisation, payload).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatCannedResponseDeleteExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatCannedResponseApi();
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatCannedResponseCollectionPayload(); // LiveChatCannedResponseCollectionPayload | Live chat canned response collection payload

            try
            {
                // delete backoffice_live_chat_canned_response
                apiInstance.backofficeLiveChatCannedResponseDelete(organisation, payload);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatCannedResponseApi.backofficeLiveChatCannedResponseDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatCannedResponseApi();
$organisation = organisation_example; // String | 
$payload = ; // LiveChatCannedResponseCollectionPayload | Live chat canned response collection payload

try {
    $api_instance->backofficeLiveChatCannedResponseDelete($organisation, $payload);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatCannedResponseApi->backofficeLiveChatCannedResponseDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatCannedResponseApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatCannedResponseApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatCannedResponseCollectionPayload->new(); # LiveChatCannedResponseCollectionPayload | Live chat canned response collection payload

eval { 
    $api_instance->backofficeLiveChatCannedResponseDelete(organisation => $organisation, payload => $payload);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatCannedResponseApi->backofficeLiveChatCannedResponseDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatCannedResponseApi()
organisation = organisation_example # String | 
payload =  # LiveChatCannedResponseCollectionPayload | Live chat canned response collection payload

try: 
    # delete backoffice_live_chat_canned_response
    api_instance.backoffice_live_chat_canned_response_delete(organisation, payload)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatCannedResponseApi->backofficeLiveChatCannedResponseDelete: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatCannedResponseList

list backoffice_live_chat_canned_response

Retrieve all canned responses.


/0.0.1/backoffice/live_chat_canned_responses/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chat_canned_responses/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatCannedResponseApi;

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

public class BackofficeLiveChatCannedResponseApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatCannedResponseApi apiInstance = new BackofficeLiveChatCannedResponseApi();
        String organisation = organisation_example; // String | 
        LiveChatCannedResponseCollectionPayload payload = ; // LiveChatCannedResponseCollectionPayload | Live chat canned response collection payload
        try {
            Live_chat_canned_response_collection result = apiInstance.backofficeLiveChatCannedResponseList(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatCannedResponseApi#backofficeLiveChatCannedResponseList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatCannedResponseApi;

public class BackofficeLiveChatCannedResponseApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatCannedResponseApi apiInstance = new BackofficeLiveChatCannedResponseApi();
        String organisation = organisation_example; // String | 
        LiveChatCannedResponseCollectionPayload payload = ; // LiveChatCannedResponseCollectionPayload | Live chat canned response collection payload
        try {
            Live_chat_canned_response_collection result = apiInstance.backofficeLiveChatCannedResponseList(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatCannedResponseApi#backofficeLiveChatCannedResponseList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
LiveChatCannedResponseCollectionPayload *payload = ; // Live chat canned response collection payload

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

// list backoffice_live_chat_canned_response
[apiInstance backofficeLiveChatCannedResponseListWith:organisation
    payload:payload
              completionHandler: ^(Live_chat_canned_response_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatCannedResponseApi()

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatCannedResponseCollectionPayload} Live chat canned response collection payload

api.backofficeLiveChatCannedResponseList(organisation, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatCannedResponseListExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatCannedResponseApi();
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatCannedResponseCollectionPayload(); // LiveChatCannedResponseCollectionPayload | Live chat canned response collection payload

            try
            {
                // list backoffice_live_chat_canned_response
                Live_chat_canned_response_collection result = apiInstance.backofficeLiveChatCannedResponseList(organisation, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatCannedResponseApi.backofficeLiveChatCannedResponseList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatCannedResponseApi();
$organisation = organisation_example; // String | 
$payload = ; // LiveChatCannedResponseCollectionPayload | Live chat canned response collection payload

try {
    $result = $api_instance->backofficeLiveChatCannedResponseList($organisation, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatCannedResponseApi->backofficeLiveChatCannedResponseList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatCannedResponseApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatCannedResponseApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatCannedResponseCollectionPayload->new(); # LiveChatCannedResponseCollectionPayload | Live chat canned response collection payload

eval { 
    my $result = $api_instance->backofficeLiveChatCannedResponseList(organisation => $organisation, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeLiveChatCannedResponseApi->backofficeLiveChatCannedResponseList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatCannedResponseApi()
organisation = organisation_example # String | 
payload =  # LiveChatCannedResponseCollectionPayload | Live chat canned response collection payload

try: 
    # list backoffice_live_chat_canned_response
    api_response = api_instance.backoffice_live_chat_canned_response_list(organisation, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatCannedResponseApi->backofficeLiveChatCannedResponseList: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeLiveChatCannedResponseRender

render backoffice_live_chat_canned_response

Render canned response


/0.0.1/backoffice/live_chat_canned_responses/{id}/render

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chat_canned_responses/{id}/render"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatCannedResponseApi;

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

public class BackofficeLiveChatCannedResponseApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatCannedResponseApi apiInstance = new BackofficeLiveChatCannedResponseApi();
        String id = id_example; // String | Canned response ID
        String organisation = organisation_example; // String | 
        LiveChatCannedResponseRenderPayload payload = ; // LiveChatCannedResponseRenderPayload | Live chat canned response render payload
        try {
            Live_chat_message result = apiInstance.backofficeLiveChatCannedResponseRender(id, organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatCannedResponseApi#backofficeLiveChatCannedResponseRender");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatCannedResponseApi;

public class BackofficeLiveChatCannedResponseApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatCannedResponseApi apiInstance = new BackofficeLiveChatCannedResponseApi();
        String id = id_example; // String | Canned response ID
        String organisation = organisation_example; // String | 
        LiveChatCannedResponseRenderPayload payload = ; // LiveChatCannedResponseRenderPayload | Live chat canned response render payload
        try {
            Live_chat_message result = apiInstance.backofficeLiveChatCannedResponseRender(id, organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatCannedResponseApi#backofficeLiveChatCannedResponseRender");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Canned response ID
String *organisation = organisation_example; // 
LiveChatCannedResponseRenderPayload *payload = ; // Live chat canned response render payload

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

// render backoffice_live_chat_canned_response
[apiInstance backofficeLiveChatCannedResponseRenderWith:id
    organisation:organisation
    payload:payload
              completionHandler: ^(Live_chat_message output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatCannedResponseApi()

var id = id_example; // {String} Canned response ID

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatCannedResponseRenderPayload} Live chat canned response render payload

api.backofficeLiveChatCannedResponseRender(id, organisation, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatCannedResponseRenderExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatCannedResponseApi();
            var id = id_example;  // String | Canned response ID
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatCannedResponseRenderPayload(); // LiveChatCannedResponseRenderPayload | Live chat canned response render payload

            try
            {
                // render backoffice_live_chat_canned_response
                Live_chat_message result = apiInstance.backofficeLiveChatCannedResponseRender(id, organisation, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatCannedResponseApi.backofficeLiveChatCannedResponseRender: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatCannedResponseApi();
$id = id_example; // String | Canned response ID
$organisation = organisation_example; // String | 
$payload = ; // LiveChatCannedResponseRenderPayload | Live chat canned response render payload

try {
    $result = $api_instance->backofficeLiveChatCannedResponseRender($id, $organisation, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatCannedResponseApi->backofficeLiveChatCannedResponseRender: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatCannedResponseApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatCannedResponseApi->new();
my $id = id_example; # String | Canned response ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatCannedResponseRenderPayload->new(); # LiveChatCannedResponseRenderPayload | Live chat canned response render payload

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatCannedResponseApi()
id = id_example # String | Canned response ID
organisation = organisation_example # String | 
payload =  # LiveChatCannedResponseRenderPayload | Live chat canned response render payload

try: 
    # render backoffice_live_chat_canned_response
    api_response = api_instance.backoffice_live_chat_canned_response_render(id, organisation, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatCannedResponseApi->backofficeLiveChatCannedResponseRender: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Canned response ID
Required
Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatCannedResponseShow

show backoffice_live_chat_canned_response

Get canned response


/0.0.1/backoffice/live_chat_canned_responses/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chat_canned_responses/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatCannedResponseApi;

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

public class BackofficeLiveChatCannedResponseApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatCannedResponseApi apiInstance = new BackofficeLiveChatCannedResponseApi();
        String id = id_example; // String | Canned response ID
        String organisation = organisation_example; // String | 
        try {
            Live_chat_canned_response result = apiInstance.backofficeLiveChatCannedResponseShow(id, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatCannedResponseApi#backofficeLiveChatCannedResponseShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatCannedResponseApi;

public class BackofficeLiveChatCannedResponseApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatCannedResponseApi apiInstance = new BackofficeLiveChatCannedResponseApi();
        String id = id_example; // String | Canned response ID
        String organisation = organisation_example; // String | 
        try {
            Live_chat_canned_response result = apiInstance.backofficeLiveChatCannedResponseShow(id, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatCannedResponseApi#backofficeLiveChatCannedResponseShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Canned response ID
String *organisation = organisation_example; // 

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

// show backoffice_live_chat_canned_response
[apiInstance backofficeLiveChatCannedResponseShowWith:id
    organisation:organisation
              completionHandler: ^(Live_chat_canned_response output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatCannedResponseApi()

var id = id_example; // {String} Canned response ID

var organisation = organisation_example; // {String} 

api.backofficeLiveChatCannedResponseShow(id, organisation).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatCannedResponseShowExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatCannedResponseApi();
            var id = id_example;  // String | Canned response ID
            var organisation = organisation_example;  // String | 

            try
            {
                // show backoffice_live_chat_canned_response
                Live_chat_canned_response result = apiInstance.backofficeLiveChatCannedResponseShow(id, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatCannedResponseApi.backofficeLiveChatCannedResponseShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatCannedResponseApi();
$id = id_example; // String | Canned response ID
$organisation = organisation_example; // String | 

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

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatCannedResponseApi->new();
my $id = id_example; # String | Canned response ID
my $organisation = organisation_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatCannedResponseApi()
id = id_example # String | Canned response ID
organisation = organisation_example # String | 

try: 
    # show backoffice_live_chat_canned_response
    api_response = api_instance.backoffice_live_chat_canned_response_show(id, organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatCannedResponseApi->backofficeLiveChatCannedResponseShow: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Canned response ID
Required
Header parameters
Name Description
Organisation*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeLiveChatCannedResponseUpdate

update backoffice_live_chat_canned_response

Change canned response


/0.0.1/backoffice/live_chat_canned_responses/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/live_chat_canned_responses/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLiveChatCannedResponseApi;

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

public class BackofficeLiveChatCannedResponseApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLiveChatCannedResponseApi apiInstance = new BackofficeLiveChatCannedResponseApi();
        String id = id_example; // String | Canned response ID
        String organisation = organisation_example; // String | 
        LiveChatCannedResponsePayload payload = ; // LiveChatCannedResponsePayload | Live chat canned response payload
        try {
            Live_chat_canned_response result = apiInstance.backofficeLiveChatCannedResponseUpdate(id, organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatCannedResponseApi#backofficeLiveChatCannedResponseUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLiveChatCannedResponseApi;

public class BackofficeLiveChatCannedResponseApiExample {

    public static void main(String[] args) {
        BackofficeLiveChatCannedResponseApi apiInstance = new BackofficeLiveChatCannedResponseApi();
        String id = id_example; // String | Canned response ID
        String organisation = organisation_example; // String | 
        LiveChatCannedResponsePayload payload = ; // LiveChatCannedResponsePayload | Live chat canned response payload
        try {
            Live_chat_canned_response result = apiInstance.backofficeLiveChatCannedResponseUpdate(id, organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLiveChatCannedResponseApi#backofficeLiveChatCannedResponseUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Canned response ID
String *organisation = organisation_example; // 
LiveChatCannedResponsePayload *payload = ; // Live chat canned response payload

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

// update backoffice_live_chat_canned_response
[apiInstance backofficeLiveChatCannedResponseUpdateWith:id
    organisation:organisation
    payload:payload
              completionHandler: ^(Live_chat_canned_response output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLiveChatCannedResponseApi()

var id = id_example; // {String} Canned response ID

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatCannedResponsePayload} Live chat canned response payload

api.backofficeLiveChatCannedResponseUpdate(id, organisation, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLiveChatCannedResponseUpdateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLiveChatCannedResponseApi();
            var id = id_example;  // String | Canned response ID
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatCannedResponsePayload(); // LiveChatCannedResponsePayload | Live chat canned response payload

            try
            {
                // update backoffice_live_chat_canned_response
                Live_chat_canned_response result = apiInstance.backofficeLiveChatCannedResponseUpdate(id, organisation, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLiveChatCannedResponseApi.backofficeLiveChatCannedResponseUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLiveChatCannedResponseApi();
$id = id_example; // String | Canned response ID
$organisation = organisation_example; // String | 
$payload = ; // LiveChatCannedResponsePayload | Live chat canned response payload

try {
    $result = $api_instance->backofficeLiveChatCannedResponseUpdate($id, $organisation, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLiveChatCannedResponseApi->backofficeLiveChatCannedResponseUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLiveChatCannedResponseApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLiveChatCannedResponseApi->new();
my $id = id_example; # String | Canned response ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatCannedResponsePayload->new(); # LiveChatCannedResponsePayload | Live chat canned response payload

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLiveChatCannedResponseApi()
id = id_example # String | Canned response ID
organisation = organisation_example # String | 
payload =  # LiveChatCannedResponsePayload | Live chat canned response payload

try: 
    # update backoffice_live_chat_canned_response
    api_response = api_instance.backoffice_live_chat_canned_response_update(id, organisation, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeLiveChatCannedResponseApi->backofficeLiveChatCannedResponseUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Canned response ID
Required
Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


BackofficeLock

backofficeLockCreate

create backoffice_lock

Obtain object lock


/0.0.1/backoffice/lock

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/lock"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLockApi;

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

public class BackofficeLockApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLockApi apiInstance = new BackofficeLockApi();
        String organisation = organisation_example; // String | 
        LockPayload payload = ; // LockPayload | Object lock payload
        try {
            Lock result = apiInstance.backofficeLockCreate(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLockApi#backofficeLockCreate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLockApi;

public class BackofficeLockApiExample {

    public static void main(String[] args) {
        BackofficeLockApi apiInstance = new BackofficeLockApi();
        String organisation = organisation_example; // String | 
        LockPayload payload = ; // LockPayload | Object lock payload
        try {
            Lock result = apiInstance.backofficeLockCreate(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLockApi#backofficeLockCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
LockPayload *payload = ; // Object lock payload

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

// create backoffice_lock
[apiInstance backofficeLockCreateWith:organisation
    payload:payload
              completionHandler: ^(Lock output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLockApi()

var organisation = organisation_example; // {String} 

var payload = ; // {LockPayload} Object lock payload

api.backofficeLockCreate(organisation, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLockCreateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLockApi();
            var organisation = organisation_example;  // String | 
            var payload = new LockPayload(); // LockPayload | Object lock payload

            try
            {
                // create backoffice_lock
                Lock result = apiInstance.backofficeLockCreate(organisation, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLockApi.backofficeLockCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLockApi();
$organisation = organisation_example; // String | 
$payload = ; // LockPayload | Object lock payload

try {
    $result = $api_instance->backofficeLockCreate($organisation, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLockApi->backofficeLockCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLockApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLockApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LockPayload->new(); # LockPayload | Object lock payload

eval { 
    my $result = $api_instance->backofficeLockCreate(organisation => $organisation, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeLockApi->backofficeLockCreate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLockApi()
organisation = organisation_example # String | 
payload =  # LockPayload | Object lock payload

try: 
    # create backoffice_lock
    api_response = api_instance.backoffice_lock_create(organisation, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeLockApi->backofficeLockCreate: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 201 - Object created

Status: 400 - Bad Request


backofficeLockDelete

delete backoffice_lock

Delete object lock


/0.0.1/backoffice/lock

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/lock"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeLockApi;

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

public class BackofficeLockApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeLockApi apiInstance = new BackofficeLockApi();
        String organisation = organisation_example; // String | 
        LockDeletePayload payload = ; // LockDeletePayload | Object delete lock payload
        try {
            apiInstance.backofficeLockDelete(organisation, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLockApi#backofficeLockDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeLockApi;

public class BackofficeLockApiExample {

    public static void main(String[] args) {
        BackofficeLockApi apiInstance = new BackofficeLockApi();
        String organisation = organisation_example; // String | 
        LockDeletePayload payload = ; // LockDeletePayload | Object delete lock payload
        try {
            apiInstance.backofficeLockDelete(organisation, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeLockApi#backofficeLockDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
LockDeletePayload *payload = ; // Object delete lock payload

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

// delete backoffice_lock
[apiInstance backofficeLockDeleteWith:organisation
    payload:payload
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeLockApi()

var organisation = organisation_example; // {String} 

var payload = ; // {LockDeletePayload} Object delete lock payload

api.backofficeLockDelete(organisation, payload).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeLockDeleteExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeLockApi();
            var organisation = organisation_example;  // String | 
            var payload = new LockDeletePayload(); // LockDeletePayload | Object delete lock payload

            try
            {
                // delete backoffice_lock
                apiInstance.backofficeLockDelete(organisation, payload);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeLockApi.backofficeLockDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeLockApi();
$organisation = organisation_example; // String | 
$payload = ; // LockDeletePayload | Object delete lock payload

try {
    $api_instance->backofficeLockDelete($organisation, $payload);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeLockApi->backofficeLockDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeLockApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeLockApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LockDeletePayload->new(); # LockDeletePayload | Object delete lock payload

eval { 
    $api_instance->backofficeLockDelete(organisation => $organisation, payload => $payload);
};
if ($@) {
    warn "Exception when calling BackofficeLockApi->backofficeLockDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeLockApi()
organisation = organisation_example # String | 
payload =  # LockDeletePayload | Object delete lock payload

try: 
    # delete backoffice_lock
    api_instance.backoffice_lock_delete(organisation, payload)
except ApiException as e:
    print("Exception when calling BackofficeLockApi->backofficeLockDelete: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request


BackofficeOauthRegistration

backofficeOauthRegistrationConfirm

confirm backoffice_oauth_registration

Confirm backoffice oauth user registration


/0.0.1/backoffice/bouser_oauth_registrations/confirm

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/backoffice/bouser_oauth_registrations/confirm"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOauthRegistrationApi;

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

public class BackofficeOauthRegistrationApiExample {

    public static void main(String[] args) {
        
        BackofficeOauthRegistrationApi apiInstance = new BackofficeOauthRegistrationApi();
        BoUserOAuthConfirmPayload payload = ; // BoUserOAuthConfirmPayload | A backoffice oauth user registration confirm payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user result = apiInstance.backofficeOauthRegistrationConfirm(payload, acceptLanguage, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOauthRegistrationApi#backofficeOauthRegistrationConfirm");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOauthRegistrationApi;

public class BackofficeOauthRegistrationApiExample {

    public static void main(String[] args) {
        BackofficeOauthRegistrationApi apiInstance = new BackofficeOauthRegistrationApi();
        BoUserOAuthConfirmPayload payload = ; // BoUserOAuthConfirmPayload | A backoffice oauth user registration confirm payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user result = apiInstance.backofficeOauthRegistrationConfirm(payload, acceptLanguage, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOauthRegistrationApi#backofficeOauthRegistrationConfirm");
            e.printStackTrace();
        }
    }
}
BoUserOAuthConfirmPayload *payload = ; // A backoffice oauth user registration confirm payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// confirm backoffice_oauth_registration
[apiInstance backofficeOauthRegistrationConfirmWith:payload
    acceptLanguage:acceptLanguage
    xForwardedFor:xForwardedFor
              completionHandler: ^(Bo_user output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.BackofficeOauthRegistrationApi()

var payload = ; // {BoUserOAuthConfirmPayload} A backoffice oauth user registration confirm payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeOauthRegistrationConfirm(payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOauthRegistrationConfirmExample
    {
        public void main()
        {
            
            var apiInstance = new BackofficeOauthRegistrationApi();
            var payload = new BoUserOAuthConfirmPayload(); // BoUserOAuthConfirmPayload | A backoffice oauth user registration confirm payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // confirm backoffice_oauth_registration
                Bo_user result = apiInstance.backofficeOauthRegistrationConfirm(payload, acceptLanguage, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOauthRegistrationApi.backofficeOauthRegistrationConfirm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BackofficeOauthRegistrationApi();
$payload = ; // BoUserOAuthConfirmPayload | A backoffice oauth user registration confirm payload
$acceptLanguage = acceptLanguage_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->backofficeOauthRegistrationConfirm($payload, $acceptLanguage, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeOauthRegistrationApi->backofficeOauthRegistrationConfirm: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeOauthRegistrationApi;

my $api_instance = WWW::SwaggerClient::BackofficeOauthRegistrationApi->new();
my $payload = WWW::SwaggerClient::Object::BoUserOAuthConfirmPayload->new(); # BoUserOAuthConfirmPayload | A backoffice oauth user registration confirm payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->backofficeOauthRegistrationConfirm(payload => $payload, acceptLanguage => $acceptLanguage, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeOauthRegistrationApi->backofficeOauthRegistrationConfirm: $@\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.BackofficeOauthRegistrationApi()
payload =  # BoUserOAuthConfirmPayload | A backoffice oauth user registration confirm payload
acceptLanguage = acceptLanguage_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # confirm backoffice_oauth_registration
    api_response = api_instance.backoffice_oauth_registration_confirm(payload, acceptLanguage=acceptLanguage, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeOauthRegistrationApi->backofficeOauthRegistrationConfirm: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Name Type Format Description
Authorization String Generated JWT
Authorization-Token-Expires String Expiration of the authorization token

Status: 400 - Bad Request


backofficeOauthRegistrationShow

show backoffice_oauth_registration

Retrieve backoffice oauth user registration with given token.


/0.0.1/backoffice/bouser_oauth_registrations/by_token/{id}

Usage and SDK Samples

curl -X GET "https://api.quriobot.com/0.0.1/backoffice/bouser_oauth_registrations/by_token/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOauthRegistrationApi;

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

public class BackofficeOauthRegistrationApiExample {

    public static void main(String[] args) {
        
        BackofficeOauthRegistrationApi apiInstance = new BackofficeOauthRegistrationApi();
        String id = id_example; // String | Backoffice user oauth registration token
        try {
            Bo_user_oauth_registration result = apiInstance.backofficeOauthRegistrationShow(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOauthRegistrationApi#backofficeOauthRegistrationShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOauthRegistrationApi;

public class BackofficeOauthRegistrationApiExample {

    public static void main(String[] args) {
        BackofficeOauthRegistrationApi apiInstance = new BackofficeOauthRegistrationApi();
        String id = id_example; // String | Backoffice user oauth registration token
        try {
            Bo_user_oauth_registration result = apiInstance.backofficeOauthRegistrationShow(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOauthRegistrationApi#backofficeOauthRegistrationShow");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Backoffice user oauth registration token

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

// show backoffice_oauth_registration
[apiInstance backofficeOauthRegistrationShowWith:id
              completionHandler: ^(Bo_user_oauth_registration output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.BackofficeOauthRegistrationApi()

var id = id_example; // {String} Backoffice user oauth registration token

api.backofficeOauthRegistrationShow(id).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOauthRegistrationShowExample
    {
        public void main()
        {
            
            var apiInstance = new BackofficeOauthRegistrationApi();
            var id = id_example;  // String | Backoffice user oauth registration token

            try
            {
                // show backoffice_oauth_registration
                Bo_user_oauth_registration result = apiInstance.backofficeOauthRegistrationShow(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOauthRegistrationApi.backofficeOauthRegistrationShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BackofficeOauthRegistrationApi();
$id = id_example; // String | Backoffice user oauth registration token

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

my $api_instance = WWW::SwaggerClient::BackofficeOauthRegistrationApi->new();
my $id = id_example; # String | Backoffice user oauth registration token

eval { 
    my $result = $api_instance->backofficeOauthRegistrationShow(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeOauthRegistrationApi->backofficeOauthRegistrationShow: $@\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.BackofficeOauthRegistrationApi()
id = id_example # String | Backoffice user oauth registration token

try: 
    # show backoffice_oauth_registration
    api_response = api_instance.backoffice_oauth_registration_show(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeOauthRegistrationApi->backofficeOauthRegistrationShow: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Backoffice user oauth registration token
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 404 - Not Found


BackofficeOrganisation

backofficeOrganisationActivate

activate backoffice_organisation

Activate the organisation. Meant to be used by the main organization with the agency subscription


/0.0.1/backoffice/organisations/activate

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/organisations/activate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOrganisationApi;

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

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        OrganisationActivatePayload payload = ; // OrganisationActivatePayload | Organisation activate payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Organisation_activation_result result = apiInstance.backofficeOrganisationActivate(payload, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationActivate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOrganisationApi;

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        OrganisationActivatePayload payload = ; // OrganisationActivatePayload | Organisation activate payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Organisation_activation_result result = apiInstance.backofficeOrganisationActivate(payload, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationActivate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

OrganisationActivatePayload *payload = ; // Organisation activate payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)

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

// activate backoffice_organisation
[apiInstance backofficeOrganisationActivateWith:payload
    acceptLanguage:acceptLanguage
    organisation:organisation
              completionHandler: ^(Organisation_activation_result output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeOrganisationApi()

var payload = ; // {OrganisationActivatePayload} Organisation activate payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example // {String} 
};
api.backofficeOrganisationActivate(payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOrganisationActivateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeOrganisationApi();
            var payload = new OrganisationActivatePayload(); // OrganisationActivatePayload | Organisation activate payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // activate backoffice_organisation
                Organisation_activation_result result = apiInstance.backofficeOrganisationActivate(payload, acceptLanguage, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOrganisationApi.backofficeOrganisationActivate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeOrganisationApi();
$payload = ; // OrganisationActivatePayload | Organisation activate payload
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeOrganisationActivate($payload, $acceptLanguage, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeOrganisationApi->backofficeOrganisationActivate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeOrganisationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeOrganisationApi->new();
my $payload = WWW::SwaggerClient::Object::OrganisationActivatePayload->new(); # OrganisationActivatePayload | Organisation activate payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 

eval { 
    my $result = $api_instance->backofficeOrganisationActivate(payload => $payload, acceptLanguage => $acceptLanguage, organisation => $organisation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeOrganisationApi->backofficeOrganisationActivate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeOrganisationApi()
payload =  # OrganisationActivatePayload | Organisation activate payload
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)

try: 
    # activate backoffice_organisation
    api_response = api_instance.backoffice_organisation_activate(payload, acceptLanguage=acceptLanguage, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeOrganisationApi->backofficeOrganisationActivate: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeOrganisationCreate

create backoffice_organisation

Create new organisation


/0.0.1/backoffice/organisations

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/organisations"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOrganisationApi;

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

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        OrganisationCreatePayload payload = ; // OrganisationCreatePayload | Organisation create payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Organisation result = apiInstance.backofficeOrganisationCreate(payload, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationCreate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOrganisationApi;

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        OrganisationCreatePayload payload = ; // OrganisationCreatePayload | Organisation create payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Organisation result = apiInstance.backofficeOrganisationCreate(payload, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

OrganisationCreatePayload *payload = ; // Organisation create payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)

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

// create backoffice_organisation
[apiInstance backofficeOrganisationCreateWith:payload
    acceptLanguage:acceptLanguage
    organisation:organisation
              completionHandler: ^(Organisation output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeOrganisationApi()

var payload = ; // {OrganisationCreatePayload} Organisation create payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example // {String} 
};
api.backofficeOrganisationCreate(payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOrganisationCreateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeOrganisationApi();
            var payload = new OrganisationCreatePayload(); // OrganisationCreatePayload | Organisation create payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // create backoffice_organisation
                Organisation result = apiInstance.backofficeOrganisationCreate(payload, acceptLanguage, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOrganisationApi.backofficeOrganisationCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeOrganisationApi();
$payload = ; // OrganisationCreatePayload | Organisation create payload
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeOrganisationCreate($payload, $acceptLanguage, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeOrganisationApi->backofficeOrganisationCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeOrganisationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeOrganisationApi->new();
my $payload = WWW::SwaggerClient::Object::OrganisationCreatePayload->new(); # OrganisationCreatePayload | Organisation create payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 

eval { 
    my $result = $api_instance->backofficeOrganisationCreate(payload => $payload, acceptLanguage => $acceptLanguage, organisation => $organisation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeOrganisationApi->backofficeOrganisationCreate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeOrganisationApi()
payload =  # OrganisationCreatePayload | Organisation create payload
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)

try: 
    # create backoffice_organisation
    api_response = api_instance.backoffice_organisation_create(payload, acceptLanguage=acceptLanguage, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeOrganisationApi->backofficeOrganisationCreate: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeOrganisationCreateDomain

create_domain backoffice_organisation

Create new domain


/0.0.1/backoffice/organisations/{id}/domain_settings/domains

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/organisations/{id}/domain_settings/domains"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOrganisationApi;

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

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        DomainCreatePayload payload = ; // DomainCreatePayload | Domain create payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Domain result = apiInstance.backofficeOrganisationCreateDomain(id, payload, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationCreateDomain");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOrganisationApi;

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        DomainCreatePayload payload = ; // DomainCreatePayload | Domain create payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Domain result = apiInstance.backofficeOrganisationCreateDomain(id, payload, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationCreateDomain");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Organisation ID
DomainCreatePayload *payload = ; // Domain create payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)

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

// create_domain backoffice_organisation
[apiInstance backofficeOrganisationCreateDomainWith:id
    payload:payload
    acceptLanguage:acceptLanguage
    organisation:organisation
              completionHandler: ^(Domain output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeOrganisationApi()

var id = id_example; // {String} Organisation ID

var payload = ; // {DomainCreatePayload} Domain create payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example // {String} 
};
api.backofficeOrganisationCreateDomain(id, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOrganisationCreateDomainExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeOrganisationApi();
            var id = id_example;  // String | Organisation ID
            var payload = new DomainCreatePayload(); // DomainCreatePayload | Domain create payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // create_domain backoffice_organisation
                Domain result = apiInstance.backofficeOrganisationCreateDomain(id, payload, acceptLanguage, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOrganisationApi.backofficeOrganisationCreateDomain: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeOrganisationApi();
$id = id_example; // String | Organisation ID
$payload = ; // DomainCreatePayload | Domain create payload
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeOrganisationCreateDomain($id, $payload, $acceptLanguage, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeOrganisationApi->backofficeOrganisationCreateDomain: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeOrganisationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeOrganisationApi->new();
my $id = id_example; # String | Organisation ID
my $payload = WWW::SwaggerClient::Object::DomainCreatePayload->new(); # DomainCreatePayload | Domain create payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 

eval { 
    my $result = $api_instance->backofficeOrganisationCreateDomain(id => $id, payload => $payload, acceptLanguage => $acceptLanguage, organisation => $organisation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeOrganisationApi->backofficeOrganisationCreateDomain: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeOrganisationApi()
id = id_example # String | Organisation ID
payload =  # DomainCreatePayload | Domain create payload
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)

try: 
    # create_domain backoffice_organisation
    api_response = api_instance.backoffice_organisation_create_domain(id, payload, acceptLanguage=acceptLanguage, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeOrganisationApi->backofficeOrganisationCreateDomain: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Organisation ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeOrganisationCreateFromAddress

create_from_address backoffice_organisation

Create new `from` address


/0.0.1/backoffice/organisations/{id}/email_settings/from_addresses

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/organisations/{id}/email_settings/from_addresses"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOrganisationApi;

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

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        EmailAddressCreatePayload payload = ; // EmailAddressCreatePayload | Email address create payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Email_from_address result = apiInstance.backofficeOrganisationCreateFromAddress(id, payload, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationCreateFromAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOrganisationApi;

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        EmailAddressCreatePayload payload = ; // EmailAddressCreatePayload | Email address create payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Email_from_address result = apiInstance.backofficeOrganisationCreateFromAddress(id, payload, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationCreateFromAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Organisation ID
EmailAddressCreatePayload *payload = ; // Email address create payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)

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

// create_from_address backoffice_organisation
[apiInstance backofficeOrganisationCreateFromAddressWith:id
    payload:payload
    acceptLanguage:acceptLanguage
    organisation:organisation
              completionHandler: ^(Email_from_address output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeOrganisationApi()

var id = id_example; // {String} Organisation ID

var payload = ; // {EmailAddressCreatePayload} Email address create payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example // {String} 
};
api.backofficeOrganisationCreateFromAddress(id, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOrganisationCreateFromAddressExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeOrganisationApi();
            var id = id_example;  // String | Organisation ID
            var payload = new EmailAddressCreatePayload(); // EmailAddressCreatePayload | Email address create payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // create_from_address backoffice_organisation
                Email_from_address result = apiInstance.backofficeOrganisationCreateFromAddress(id, payload, acceptLanguage, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOrganisationApi.backofficeOrganisationCreateFromAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeOrganisationApi();
$id = id_example; // String | Organisation ID
$payload = ; // EmailAddressCreatePayload | Email address create payload
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeOrganisationCreateFromAddress($id, $payload, $acceptLanguage, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeOrganisationApi->backofficeOrganisationCreateFromAddress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeOrganisationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeOrganisationApi->new();
my $id = id_example; # String | Organisation ID
my $payload = WWW::SwaggerClient::Object::EmailAddressCreatePayload->new(); # EmailAddressCreatePayload | Email address create payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 

eval { 
    my $result = $api_instance->backofficeOrganisationCreateFromAddress(id => $id, payload => $payload, acceptLanguage => $acceptLanguage, organisation => $organisation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeOrganisationApi->backofficeOrganisationCreateFromAddress: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeOrganisationApi()
id = id_example # String | Organisation ID
payload =  # EmailAddressCreatePayload | Email address create payload
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)

try: 
    # create_from_address backoffice_organisation
    api_response = api_instance.backoffice_organisation_create_from_address(id, payload, acceptLanguage=acceptLanguage, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeOrganisationApi->backofficeOrganisationCreateFromAddress: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Organisation ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeOrganisationCreateMandatePayment

create_mandate_payment backoffice_organisation

Create new mandate payment


/0.0.1/backoffice/organisations/{id}/billing_settings/mandate_payments

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/organisations/{id}/billing_settings/mandate_payments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOrganisationApi;

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

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        PaymentCreatePayload payload = ; // PaymentCreatePayload | Payment create payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Payment result = apiInstance.backofficeOrganisationCreateMandatePayment(id, payload, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationCreateMandatePayment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOrganisationApi;

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        PaymentCreatePayload payload = ; // PaymentCreatePayload | Payment create payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Payment result = apiInstance.backofficeOrganisationCreateMandatePayment(id, payload, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationCreateMandatePayment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Organisation ID
PaymentCreatePayload *payload = ; // Payment create payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)

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

// create_mandate_payment backoffice_organisation
[apiInstance backofficeOrganisationCreateMandatePaymentWith:id
    payload:payload
    acceptLanguage:acceptLanguage
    organisation:organisation
              completionHandler: ^(Payment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeOrganisationApi()

var id = id_example; // {String} Organisation ID

var payload = ; // {PaymentCreatePayload} Payment create payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example // {String} 
};
api.backofficeOrganisationCreateMandatePayment(id, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOrganisationCreateMandatePaymentExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeOrganisationApi();
            var id = id_example;  // String | Organisation ID
            var payload = new PaymentCreatePayload(); // PaymentCreatePayload | Payment create payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // create_mandate_payment backoffice_organisation
                Payment result = apiInstance.backofficeOrganisationCreateMandatePayment(id, payload, acceptLanguage, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOrganisationApi.backofficeOrganisationCreateMandatePayment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeOrganisationApi();
$id = id_example; // String | Organisation ID
$payload = ; // PaymentCreatePayload | Payment create payload
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeOrganisationCreateMandatePayment($id, $payload, $acceptLanguage, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeOrganisationApi->backofficeOrganisationCreateMandatePayment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeOrganisationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeOrganisationApi->new();
my $id = id_example; # String | Organisation ID
my $payload = WWW::SwaggerClient::Object::PaymentCreatePayload->new(); # PaymentCreatePayload | Payment create payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 

eval { 
    my $result = $api_instance->backofficeOrganisationCreateMandatePayment(id => $id, payload => $payload, acceptLanguage => $acceptLanguage, organisation => $organisation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeOrganisationApi->backofficeOrganisationCreateMandatePayment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeOrganisationApi()
id = id_example # String | Organisation ID
payload =  # PaymentCreatePayload | Payment create payload
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)

try: 
    # create_mandate_payment backoffice_organisation
    api_response = api_instance.backoffice_organisation_create_mandate_payment(id, payload, acceptLanguage=acceptLanguage, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeOrganisationApi->backofficeOrganisationCreateMandatePayment: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Organisation ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeOrganisationCreateReplytoAddress

create_replyto_address backoffice_organisation

Create new `reply to` address


/0.0.1/backoffice/organisations/{id}/email_settings/replyto_addresses

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/organisations/{id}/email_settings/replyto_addresses"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOrganisationApi;

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

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        EmailAddressCreatePayload payload = ; // EmailAddressCreatePayload | Email address create payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Email_replyto_address result = apiInstance.backofficeOrganisationCreateReplytoAddress(id, payload, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationCreateReplytoAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOrganisationApi;

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        EmailAddressCreatePayload payload = ; // EmailAddressCreatePayload | Email address create payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Email_replyto_address result = apiInstance.backofficeOrganisationCreateReplytoAddress(id, payload, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationCreateReplytoAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Organisation ID
EmailAddressCreatePayload *payload = ; // Email address create payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)

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

// create_replyto_address backoffice_organisation
[apiInstance backofficeOrganisationCreateReplytoAddressWith:id
    payload:payload
    acceptLanguage:acceptLanguage
    organisation:organisation
              completionHandler: ^(Email_replyto_address output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeOrganisationApi()

var id = id_example; // {String} Organisation ID

var payload = ; // {EmailAddressCreatePayload} Email address create payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example // {String} 
};
api.backofficeOrganisationCreateReplytoAddress(id, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOrganisationCreateReplytoAddressExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeOrganisationApi();
            var id = id_example;  // String | Organisation ID
            var payload = new EmailAddressCreatePayload(); // EmailAddressCreatePayload | Email address create payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // create_replyto_address backoffice_organisation
                Email_replyto_address result = apiInstance.backofficeOrganisationCreateReplytoAddress(id, payload, acceptLanguage, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOrganisationApi.backofficeOrganisationCreateReplytoAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeOrganisationApi();
$id = id_example; // String | Organisation ID
$payload = ; // EmailAddressCreatePayload | Email address create payload
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeOrganisationCreateReplytoAddress($id, $payload, $acceptLanguage, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeOrganisationApi->backofficeOrganisationCreateReplytoAddress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeOrganisationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeOrganisationApi->new();
my $id = id_example; # String | Organisation ID
my $payload = WWW::SwaggerClient::Object::EmailAddressCreatePayload->new(); # EmailAddressCreatePayload | Email address create payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 

eval { 
    my $result = $api_instance->backofficeOrganisationCreateReplytoAddress(id => $id, payload => $payload, acceptLanguage => $acceptLanguage, organisation => $organisation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeOrganisationApi->backofficeOrganisationCreateReplytoAddress: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeOrganisationApi()
id = id_example # String | Organisation ID
payload =  # EmailAddressCreatePayload | Email address create payload
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)

try: 
    # create_replyto_address backoffice_organisation
    api_response = api_instance.backoffice_organisation_create_replyto_address(id, payload, acceptLanguage=acceptLanguage, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeOrganisationApi->backofficeOrganisationCreateReplytoAddress: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Organisation ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeOrganisationDeactivate

deactivate backoffice_organisation

Deactivate the organisation. Meant to be used by the main organization with the agency subscription


/0.0.1/backoffice/organisations/deactivate

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/organisations/deactivate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOrganisationApi;

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

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        OrganisationDeactivatePayload payload = ; // OrganisationDeactivatePayload | Organisation deactivate payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeOrganisationDeactivate(payload, acceptLanguage, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationDeactivate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOrganisationApi;

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        OrganisationDeactivatePayload payload = ; // OrganisationDeactivatePayload | Organisation deactivate payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeOrganisationDeactivate(payload, acceptLanguage, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationDeactivate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

OrganisationDeactivatePayload *payload = ; // Organisation deactivate payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)

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

// deactivate backoffice_organisation
[apiInstance backofficeOrganisationDeactivateWith:payload
    acceptLanguage:acceptLanguage
    organisation:organisation
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeOrganisationApi()

var payload = ; // {OrganisationDeactivatePayload} Organisation deactivate payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example // {String} 
};
api.backofficeOrganisationDeactivate(payload, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOrganisationDeactivateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeOrganisationApi();
            var payload = new OrganisationDeactivatePayload(); // OrganisationDeactivatePayload | Organisation deactivate payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // deactivate backoffice_organisation
                apiInstance.backofficeOrganisationDeactivate(payload, acceptLanguage, organisation);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOrganisationApi.backofficeOrganisationDeactivate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeOrganisationApi();
$payload = ; // OrganisationDeactivatePayload | Organisation deactivate payload
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 

try {
    $api_instance->backofficeOrganisationDeactivate($payload, $acceptLanguage, $organisation);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeOrganisationApi->backofficeOrganisationDeactivate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeOrganisationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeOrganisationApi->new();
my $payload = WWW::SwaggerClient::Object::OrganisationDeactivatePayload->new(); # OrganisationDeactivatePayload | Organisation deactivate payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 

eval { 
    $api_instance->backofficeOrganisationDeactivate(payload => $payload, acceptLanguage => $acceptLanguage, organisation => $organisation);
};
if ($@) {
    warn "Exception when calling BackofficeOrganisationApi->backofficeOrganisationDeactivate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeOrganisationApi()
payload =  # OrganisationDeactivatePayload | Organisation deactivate payload
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)

try: 
    # deactivate backoffice_organisation
    api_instance.backoffice_organisation_deactivate(payload, acceptLanguage=acceptLanguage, organisation=organisation)
except ApiException as e:
    print("Exception when calling BackofficeOrganisationApi->backofficeOrganisationDeactivate: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeOrganisationDelete

delete backoffice_organisation


/0.0.1/backoffice/organisations/{id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/organisations/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOrganisationApi;

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

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeOrganisationDelete(id, acceptLanguage, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOrganisationApi;

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeOrganisationDelete(id, acceptLanguage, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Organisation ID
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)

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

// delete backoffice_organisation
[apiInstance backofficeOrganisationDeleteWith:id
    acceptLanguage:acceptLanguage
    organisation:organisation
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeOrganisationApi()

var id = id_example; // {String} Organisation ID

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example // {String} 
};
api.backofficeOrganisationDelete(id, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOrganisationDeleteExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeOrganisationApi();
            var id = id_example;  // String | Organisation ID
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // delete backoffice_organisation
                apiInstance.backofficeOrganisationDelete(id, acceptLanguage, organisation);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOrganisationApi.backofficeOrganisationDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeOrganisationApi();
$id = id_example; // String | Organisation ID
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 

try {
    $api_instance->backofficeOrganisationDelete($id, $acceptLanguage, $organisation);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeOrganisationApi->backofficeOrganisationDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeOrganisationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeOrganisationApi->new();
my $id = id_example; # String | Organisation ID
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 

eval { 
    $api_instance->backofficeOrganisationDelete(id => $id, acceptLanguage => $acceptLanguage, organisation => $organisation);
};
if ($@) {
    warn "Exception when calling BackofficeOrganisationApi->backofficeOrganisationDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeOrganisationApi()
id = id_example # String | Organisation ID
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)

try: 
    # delete backoffice_organisation
    api_instance.backoffice_organisation_delete(id, acceptLanguage=acceptLanguage, organisation=organisation)
except ApiException as e:
    print("Exception when calling BackofficeOrganisationApi->backofficeOrganisationDelete: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Organisation ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation
String

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeOrganisationDeleteDomain

delete_domain backoffice_organisation

Delete domain


/0.0.1/backoffice/organisations/{id}/domain_settings/domains/{domain_id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/organisations/{id}/domain_settings/domains/{domain_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOrganisationApi;

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

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String domainId = domainId_example; // String | Domain ID
        String id = id_example; // String | Organisation ID
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeOrganisationDeleteDomain(domainId, id, acceptLanguage, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationDeleteDomain");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOrganisationApi;

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String domainId = domainId_example; // String | Domain ID
        String id = id_example; // String | Organisation ID
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeOrganisationDeleteDomain(domainId, id, acceptLanguage, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationDeleteDomain");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *domainId = domainId_example; // Domain ID
String *id = id_example; // Organisation ID
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)

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

// delete_domain backoffice_organisation
[apiInstance backofficeOrganisationDeleteDomainWith:domainId
    id:id
    acceptLanguage:acceptLanguage
    organisation:organisation
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeOrganisationApi()

var domainId = domainId_example; // {String} Domain ID

var id = id_example; // {String} Organisation ID

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example // {String} 
};
api.backofficeOrganisationDeleteDomain(domainId, id, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOrganisationDeleteDomainExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeOrganisationApi();
            var domainId = domainId_example;  // String | Domain ID
            var id = id_example;  // String | Organisation ID
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // delete_domain backoffice_organisation
                apiInstance.backofficeOrganisationDeleteDomain(domainId, id, acceptLanguage, organisation);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOrganisationApi.backofficeOrganisationDeleteDomain: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeOrganisationApi();
$domainId = domainId_example; // String | Domain ID
$id = id_example; // String | Organisation ID
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 

try {
    $api_instance->backofficeOrganisationDeleteDomain($domainId, $id, $acceptLanguage, $organisation);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeOrganisationApi->backofficeOrganisationDeleteDomain: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeOrganisationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeOrganisationApi->new();
my $domainId = domainId_example; # String | Domain ID
my $id = id_example; # String | Organisation ID
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 

eval { 
    $api_instance->backofficeOrganisationDeleteDomain(domainId => $domainId, id => $id, acceptLanguage => $acceptLanguage, organisation => $organisation);
};
if ($@) {
    warn "Exception when calling BackofficeOrganisationApi->backofficeOrganisationDeleteDomain: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeOrganisationApi()
domainId = domainId_example # String | Domain ID
id = id_example # String | Organisation ID
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)

try: 
    # delete_domain backoffice_organisation
    api_instance.backoffice_organisation_delete_domain(domainId, id, acceptLanguage=acceptLanguage, organisation=organisation)
except ApiException as e:
    print("Exception when calling BackofficeOrganisationApi->backofficeOrganisationDeleteDomain: %s\n" % e)

Parameters

Path parameters
Name Description
domain_id*
String
Domain ID
Required
id*
String
Organisation ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation
String

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeOrganisationDeleteFromAddress

delete_from_address backoffice_organisation

Delete `from` address


/0.0.1/backoffice/organisations/{id}/email_settings/from_addresses/{address_id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/organisations/{id}/email_settings/from_addresses/{address_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOrganisationApi;

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

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String addressId = addressId_example; // String | Address ID
        String id = id_example; // String | Organisation ID
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeOrganisationDeleteFromAddress(addressId, id, acceptLanguage, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationDeleteFromAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOrganisationApi;

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String addressId = addressId_example; // String | Address ID
        String id = id_example; // String | Organisation ID
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeOrganisationDeleteFromAddress(addressId, id, acceptLanguage, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationDeleteFromAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *addressId = addressId_example; // Address ID
String *id = id_example; // Organisation ID
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)

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

// delete_from_address backoffice_organisation
[apiInstance backofficeOrganisationDeleteFromAddressWith:addressId
    id:id
    acceptLanguage:acceptLanguage
    organisation:organisation
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeOrganisationApi()

var addressId = addressId_example; // {String} Address ID

var id = id_example; // {String} Organisation ID

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example // {String} 
};
api.backofficeOrganisationDeleteFromAddress(addressId, id, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOrganisationDeleteFromAddressExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeOrganisationApi();
            var addressId = addressId_example;  // String | Address ID
            var id = id_example;  // String | Organisation ID
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // delete_from_address backoffice_organisation
                apiInstance.backofficeOrganisationDeleteFromAddress(addressId, id, acceptLanguage, organisation);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOrganisationApi.backofficeOrganisationDeleteFromAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeOrganisationApi();
$addressId = addressId_example; // String | Address ID
$id = id_example; // String | Organisation ID
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 

try {
    $api_instance->backofficeOrganisationDeleteFromAddress($addressId, $id, $acceptLanguage, $organisation);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeOrganisationApi->backofficeOrganisationDeleteFromAddress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeOrganisationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeOrganisationApi->new();
my $addressId = addressId_example; # String | Address ID
my $id = id_example; # String | Organisation ID
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 

eval { 
    $api_instance->backofficeOrganisationDeleteFromAddress(addressId => $addressId, id => $id, acceptLanguage => $acceptLanguage, organisation => $organisation);
};
if ($@) {
    warn "Exception when calling BackofficeOrganisationApi->backofficeOrganisationDeleteFromAddress: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeOrganisationApi()
addressId = addressId_example # String | Address ID
id = id_example # String | Organisation ID
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)

try: 
    # delete_from_address backoffice_organisation
    api_instance.backoffice_organisation_delete_from_address(addressId, id, acceptLanguage=acceptLanguage, organisation=organisation)
except ApiException as e:
    print("Exception when calling BackofficeOrganisationApi->backofficeOrganisationDeleteFromAddress: %s\n" % e)

Parameters

Path parameters
Name Description
address_id*
String
Address ID
Required
id*
String
Organisation ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation
String

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeOrganisationDeleteMembership

delete_membership backoffice_organisation

Delete membership


/0.0.1/backoffice/organisations/{id}/membership/{membership_id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/organisations/{id}/membership/{membership_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOrganisationApi;

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

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        String membershipId = membershipId_example; // String | Membership ID
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeOrganisationDeleteMembership(id, membershipId, acceptLanguage, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationDeleteMembership");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOrganisationApi;

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        String membershipId = membershipId_example; // String | Membership ID
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeOrganisationDeleteMembership(id, membershipId, acceptLanguage, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationDeleteMembership");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Organisation ID
String *membershipId = membershipId_example; // Membership ID
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)

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

// delete_membership backoffice_organisation
[apiInstance backofficeOrganisationDeleteMembershipWith:id
    membershipId:membershipId
    acceptLanguage:acceptLanguage
    organisation:organisation
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeOrganisationApi()

var id = id_example; // {String} Organisation ID

var membershipId = membershipId_example; // {String} Membership ID

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example // {String} 
};
api.backofficeOrganisationDeleteMembership(id, membershipId, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOrganisationDeleteMembershipExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeOrganisationApi();
            var id = id_example;  // String | Organisation ID
            var membershipId = membershipId_example;  // String | Membership ID
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // delete_membership backoffice_organisation
                apiInstance.backofficeOrganisationDeleteMembership(id, membershipId, acceptLanguage, organisation);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOrganisationApi.backofficeOrganisationDeleteMembership: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeOrganisationApi();
$id = id_example; // String | Organisation ID
$membershipId = membershipId_example; // String | Membership ID
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 

try {
    $api_instance->backofficeOrganisationDeleteMembership($id, $membershipId, $acceptLanguage, $organisation);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeOrganisationApi->backofficeOrganisationDeleteMembership: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeOrganisationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeOrganisationApi->new();
my $id = id_example; # String | Organisation ID
my $membershipId = membershipId_example; # String | Membership ID
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 

eval { 
    $api_instance->backofficeOrganisationDeleteMembership(id => $id, membershipId => $membershipId, acceptLanguage => $acceptLanguage, organisation => $organisation);
};
if ($@) {
    warn "Exception when calling BackofficeOrganisationApi->backofficeOrganisationDeleteMembership: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeOrganisationApi()
id = id_example # String | Organisation ID
membershipId = membershipId_example # String | Membership ID
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)

try: 
    # delete_membership backoffice_organisation
    api_instance.backoffice_organisation_delete_membership(id, membershipId, acceptLanguage=acceptLanguage, organisation=organisation)
except ApiException as e:
    print("Exception when calling BackofficeOrganisationApi->backofficeOrganisationDeleteMembership: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Organisation ID
Required
membership_id*
String
Membership ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation
String

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeOrganisationDeletePaymentMandate

delete_payment_mandate backoffice_organisation

Delete payment mandate


/0.0.1/backoffice/organisations/{id}/billing_settings/payment_mandates/{mandate_id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/organisations/{id}/billing_settings/payment_mandates/{mandate_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOrganisationApi;

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

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        String mandateId = mandateId_example; // String | Mandate ID
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeOrganisationDeletePaymentMandate(id, mandateId, acceptLanguage, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationDeletePaymentMandate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOrganisationApi;

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        String mandateId = mandateId_example; // String | Mandate ID
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeOrganisationDeletePaymentMandate(id, mandateId, acceptLanguage, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationDeletePaymentMandate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Organisation ID
String *mandateId = mandateId_example; // Mandate ID
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)

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

// delete_payment_mandate backoffice_organisation
[apiInstance backofficeOrganisationDeletePaymentMandateWith:id
    mandateId:mandateId
    acceptLanguage:acceptLanguage
    organisation:organisation
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeOrganisationApi()

var id = id_example; // {String} Organisation ID

var mandateId = mandateId_example; // {String} Mandate ID

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example // {String} 
};
api.backofficeOrganisationDeletePaymentMandate(id, mandateId, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOrganisationDeletePaymentMandateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeOrganisationApi();
            var id = id_example;  // String | Organisation ID
            var mandateId = mandateId_example;  // String | Mandate ID
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // delete_payment_mandate backoffice_organisation
                apiInstance.backofficeOrganisationDeletePaymentMandate(id, mandateId, acceptLanguage, organisation);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOrganisationApi.backofficeOrganisationDeletePaymentMandate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeOrganisationApi();
$id = id_example; // String | Organisation ID
$mandateId = mandateId_example; // String | Mandate ID
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 

try {
    $api_instance->backofficeOrganisationDeletePaymentMandate($id, $mandateId, $acceptLanguage, $organisation);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeOrganisationApi->backofficeOrganisationDeletePaymentMandate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeOrganisationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeOrganisationApi->new();
my $id = id_example; # String | Organisation ID
my $mandateId = mandateId_example; # String | Mandate ID
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 

eval { 
    $api_instance->backofficeOrganisationDeletePaymentMandate(id => $id, mandateId => $mandateId, acceptLanguage => $acceptLanguage, organisation => $organisation);
};
if ($@) {
    warn "Exception when calling BackofficeOrganisationApi->backofficeOrganisationDeletePaymentMandate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeOrganisationApi()
id = id_example # String | Organisation ID
mandateId = mandateId_example # String | Mandate ID
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)

try: 
    # delete_payment_mandate backoffice_organisation
    api_instance.backoffice_organisation_delete_payment_mandate(id, mandateId, acceptLanguage=acceptLanguage, organisation=organisation)
except ApiException as e:
    print("Exception when calling BackofficeOrganisationApi->backofficeOrganisationDeletePaymentMandate: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Organisation ID
Required
mandate_id*
String
Mandate ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation
String

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeOrganisationDeleteReplytoAddress

delete_replyto_address backoffice_organisation

Delete `replyto` address


/0.0.1/backoffice/organisations/{id}/email_settings/replyto_addresses/{address_id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/organisations/{id}/email_settings/replyto_addresses/{address_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOrganisationApi;

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

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String addressId = addressId_example; // String | Address ID
        String id = id_example; // String | Organisation ID
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeOrganisationDeleteReplytoAddress(addressId, id, acceptLanguage, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationDeleteReplytoAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOrganisationApi;

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String addressId = addressId_example; // String | Address ID
        String id = id_example; // String | Organisation ID
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeOrganisationDeleteReplytoAddress(addressId, id, acceptLanguage, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationDeleteReplytoAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *addressId = addressId_example; // Address ID
String *id = id_example; // Organisation ID
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)

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

// delete_replyto_address backoffice_organisation
[apiInstance backofficeOrganisationDeleteReplytoAddressWith:addressId
    id:id
    acceptLanguage:acceptLanguage
    organisation:organisation
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeOrganisationApi()

var addressId = addressId_example; // {String} Address ID

var id = id_example; // {String} Organisation ID

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example // {String} 
};
api.backofficeOrganisationDeleteReplytoAddress(addressId, id, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOrganisationDeleteReplytoAddressExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeOrganisationApi();
            var addressId = addressId_example;  // String | Address ID
            var id = id_example;  // String | Organisation ID
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // delete_replyto_address backoffice_organisation
                apiInstance.backofficeOrganisationDeleteReplytoAddress(addressId, id, acceptLanguage, organisation);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOrganisationApi.backofficeOrganisationDeleteReplytoAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeOrganisationApi();
$addressId = addressId_example; // String | Address ID
$id = id_example; // String | Organisation ID
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 

try {
    $api_instance->backofficeOrganisationDeleteReplytoAddress($addressId, $id, $acceptLanguage, $organisation);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeOrganisationApi->backofficeOrganisationDeleteReplytoAddress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeOrganisationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeOrganisationApi->new();
my $addressId = addressId_example; # String | Address ID
my $id = id_example; # String | Organisation ID
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 

eval { 
    $api_instance->backofficeOrganisationDeleteReplytoAddress(addressId => $addressId, id => $id, acceptLanguage => $acceptLanguage, organisation => $organisation);
};
if ($@) {
    warn "Exception when calling BackofficeOrganisationApi->backofficeOrganisationDeleteReplytoAddress: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeOrganisationApi()
addressId = addressId_example # String | Address ID
id = id_example # String | Organisation ID
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)

try: 
    # delete_replyto_address backoffice_organisation
    api_instance.backoffice_organisation_delete_replyto_address(addressId, id, acceptLanguage=acceptLanguage, organisation=organisation)
except ApiException as e:
    print("Exception when calling BackofficeOrganisationApi->backofficeOrganisationDeleteReplytoAddress: %s\n" % e)

Parameters

Path parameters
Name Description
address_id*
String
Address ID
Required
id*
String
Organisation ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation
String

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeOrganisationGetPaymentMandate

get_payment_mandate backoffice_organisation

Get payment mandate


/0.0.1/backoffice/organisations/{id}/billing_settings/payment_mandates/{mandate_id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/organisations/{id}/billing_settings/payment_mandates/{mandate_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOrganisationApi;

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

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        String mandateId = mandateId_example; // String | Mandate ID
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Payment_mandate result = apiInstance.backofficeOrganisationGetPaymentMandate(id, mandateId, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationGetPaymentMandate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOrganisationApi;

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        String mandateId = mandateId_example; // String | Mandate ID
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Payment_mandate result = apiInstance.backofficeOrganisationGetPaymentMandate(id, mandateId, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationGetPaymentMandate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Organisation ID
String *mandateId = mandateId_example; // Mandate ID
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)

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

// get_payment_mandate backoffice_organisation
[apiInstance backofficeOrganisationGetPaymentMandateWith:id
    mandateId:mandateId
    acceptLanguage:acceptLanguage
    organisation:organisation
              completionHandler: ^(Payment_mandate output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeOrganisationApi()

var id = id_example; // {String} Organisation ID

var mandateId = mandateId_example; // {String} Mandate ID

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example // {String} 
};
api.backofficeOrganisationGetPaymentMandate(id, mandateId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOrganisationGetPaymentMandateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeOrganisationApi();
            var id = id_example;  // String | Organisation ID
            var mandateId = mandateId_example;  // String | Mandate ID
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // get_payment_mandate backoffice_organisation
                Payment_mandate result = apiInstance.backofficeOrganisationGetPaymentMandate(id, mandateId, acceptLanguage, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOrganisationApi.backofficeOrganisationGetPaymentMandate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeOrganisationApi();
$id = id_example; // String | Organisation ID
$mandateId = mandateId_example; // String | Mandate ID
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeOrganisationGetPaymentMandate($id, $mandateId, $acceptLanguage, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeOrganisationApi->backofficeOrganisationGetPaymentMandate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeOrganisationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeOrganisationApi->new();
my $id = id_example; # String | Organisation ID
my $mandateId = mandateId_example; # String | Mandate ID
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 

eval { 
    my $result = $api_instance->backofficeOrganisationGetPaymentMandate(id => $id, mandateId => $mandateId, acceptLanguage => $acceptLanguage, organisation => $organisation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeOrganisationApi->backofficeOrganisationGetPaymentMandate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeOrganisationApi()
id = id_example # String | Organisation ID
mandateId = mandateId_example # String | Mandate ID
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)

try: 
    # get_payment_mandate backoffice_organisation
    api_response = api_instance.backoffice_organisation_get_payment_mandate(id, mandateId, acceptLanguage=acceptLanguage, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeOrganisationApi->backofficeOrganisationGetPaymentMandate: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Organisation ID
Required
mandate_id*
String
Mandate ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeOrganisationList

list backoffice_organisation

Retrieve all organisations.


/0.0.1/backoffice/organisations/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/organisations/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOrganisationApi;

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

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        OrganisationCollectionPayload payload = ; // OrganisationCollectionPayload | A backoffice organisation collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Organisation_collection result = apiInstance.backofficeOrganisationList(payload, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOrganisationApi;

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        OrganisationCollectionPayload payload = ; // OrganisationCollectionPayload | A backoffice organisation collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Organisation_collection result = apiInstance.backofficeOrganisationList(payload, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

OrganisationCollectionPayload *payload = ; // A backoffice organisation collection payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)

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

// list backoffice_organisation
[apiInstance backofficeOrganisationListWith:payload
    acceptLanguage:acceptLanguage
    organisation:organisation
              completionHandler: ^(Organisation_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeOrganisationApi()

var payload = ; // {OrganisationCollectionPayload} A backoffice organisation collection payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example // {String} 
};
api.backofficeOrganisationList(payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOrganisationListExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeOrganisationApi();
            var payload = new OrganisationCollectionPayload(); // OrganisationCollectionPayload | A backoffice organisation collection payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // list backoffice_organisation
                Organisation_collection result = apiInstance.backofficeOrganisationList(payload, acceptLanguage, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOrganisationApi.backofficeOrganisationList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeOrganisationApi();
$payload = ; // OrganisationCollectionPayload | A backoffice organisation collection payload
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeOrganisationList($payload, $acceptLanguage, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeOrganisationApi->backofficeOrganisationList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeOrganisationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeOrganisationApi->new();
my $payload = WWW::SwaggerClient::Object::OrganisationCollectionPayload->new(); # OrganisationCollectionPayload | A backoffice organisation collection payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 

eval { 
    my $result = $api_instance->backofficeOrganisationList(payload => $payload, acceptLanguage => $acceptLanguage, organisation => $organisation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeOrganisationApi->backofficeOrganisationList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeOrganisationApi()
payload =  # OrganisationCollectionPayload | A backoffice organisation collection payload
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)

try: 
    # list backoffice_organisation
    api_response = api_instance.backoffice_organisation_list(payload, acceptLanguage=acceptLanguage, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeOrganisationApi->backofficeOrganisationList: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeOrganisationListDomains

list_domains backoffice_organisation

List domains


/0.0.1/backoffice/organisations/{id}/domain_settings/domains/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/organisations/{id}/domain_settings/domains/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOrganisationApi;

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

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        DomainCollectionPayload payload = ; // DomainCollectionPayload | A backoffice domain collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Domain_collection result = apiInstance.backofficeOrganisationListDomains(id, payload, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationListDomains");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOrganisationApi;

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        DomainCollectionPayload payload = ; // DomainCollectionPayload | A backoffice domain collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Domain_collection result = apiInstance.backofficeOrganisationListDomains(id, payload, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationListDomains");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Organisation ID
DomainCollectionPayload *payload = ; // A backoffice domain collection payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)

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

// list_domains backoffice_organisation
[apiInstance backofficeOrganisationListDomainsWith:id
    payload:payload
    acceptLanguage:acceptLanguage
    organisation:organisation
              completionHandler: ^(Domain_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeOrganisationApi()

var id = id_example; // {String} Organisation ID

var payload = ; // {DomainCollectionPayload} A backoffice domain collection payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example // {String} 
};
api.backofficeOrganisationListDomains(id, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOrganisationListDomainsExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeOrganisationApi();
            var id = id_example;  // String | Organisation ID
            var payload = new DomainCollectionPayload(); // DomainCollectionPayload | A backoffice domain collection payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // list_domains backoffice_organisation
                Domain_collection result = apiInstance.backofficeOrganisationListDomains(id, payload, acceptLanguage, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOrganisationApi.backofficeOrganisationListDomains: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeOrganisationApi();
$id = id_example; // String | Organisation ID
$payload = ; // DomainCollectionPayload | A backoffice domain collection payload
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeOrganisationListDomains($id, $payload, $acceptLanguage, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeOrganisationApi->backofficeOrganisationListDomains: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeOrganisationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeOrganisationApi->new();
my $id = id_example; # String | Organisation ID
my $payload = WWW::SwaggerClient::Object::DomainCollectionPayload->new(); # DomainCollectionPayload | A backoffice domain collection payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 

eval { 
    my $result = $api_instance->backofficeOrganisationListDomains(id => $id, payload => $payload, acceptLanguage => $acceptLanguage, organisation => $organisation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeOrganisationApi->backofficeOrganisationListDomains: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeOrganisationApi()
id = id_example # String | Organisation ID
payload =  # DomainCollectionPayload | A backoffice domain collection payload
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)

try: 
    # list_domains backoffice_organisation
    api_response = api_instance.backoffice_organisation_list_domains(id, payload, acceptLanguage=acceptLanguage, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeOrganisationApi->backofficeOrganisationListDomains: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Organisation ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeOrganisationListFromAddresses

list_from_addresses backoffice_organisation

List `from` addresses


/0.0.1/backoffice/organisations/{id}/email_settings/from_addresses

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/organisations/{id}/email_settings/from_addresses"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOrganisationApi;

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

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Email_from_address_collection result = apiInstance.backofficeOrganisationListFromAddresses(id, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationListFromAddresses");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOrganisationApi;

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Email_from_address_collection result = apiInstance.backofficeOrganisationListFromAddresses(id, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationListFromAddresses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Organisation ID
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)

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

// list_from_addresses backoffice_organisation
[apiInstance backofficeOrganisationListFromAddressesWith:id
    acceptLanguage:acceptLanguage
    organisation:organisation
              completionHandler: ^(Email_from_address_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeOrganisationApi()

var id = id_example; // {String} Organisation ID

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example // {String} 
};
api.backofficeOrganisationListFromAddresses(id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOrganisationListFromAddressesExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeOrganisationApi();
            var id = id_example;  // String | Organisation ID
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // list_from_addresses backoffice_organisation
                Email_from_address_collection result = apiInstance.backofficeOrganisationListFromAddresses(id, acceptLanguage, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOrganisationApi.backofficeOrganisationListFromAddresses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeOrganisationApi();
$id = id_example; // String | Organisation ID
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeOrganisationListFromAddresses($id, $acceptLanguage, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeOrganisationApi->backofficeOrganisationListFromAddresses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeOrganisationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeOrganisationApi->new();
my $id = id_example; # String | Organisation ID
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeOrganisationApi()
id = id_example # String | Organisation ID
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)

try: 
    # list_from_addresses backoffice_organisation
    api_response = api_instance.backoffice_organisation_list_from_addresses(id, acceptLanguage=acceptLanguage, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeOrganisationApi->backofficeOrganisationListFromAddresses: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Organisation ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeOrganisationListMembership

list_membership backoffice_organisation

List membership


/0.0.1/backoffice/organisations/{id}/membership

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/organisations/{id}/membership"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOrganisationApi;

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

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        OrganisationMembershipCollectionPayload payload = ; // OrganisationMembershipCollectionPayload | A backoffice organisation membership collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Organisation_membership_collection result = apiInstance.backofficeOrganisationListMembership(id, payload, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationListMembership");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOrganisationApi;

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        OrganisationMembershipCollectionPayload payload = ; // OrganisationMembershipCollectionPayload | A backoffice organisation membership collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Organisation_membership_collection result = apiInstance.backofficeOrganisationListMembership(id, payload, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationListMembership");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Organisation ID
OrganisationMembershipCollectionPayload *payload = ; // A backoffice organisation membership collection payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)

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

// list_membership backoffice_organisation
[apiInstance backofficeOrganisationListMembershipWith:id
    payload:payload
    acceptLanguage:acceptLanguage
    organisation:organisation
              completionHandler: ^(Organisation_membership_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeOrganisationApi()

var id = id_example; // {String} Organisation ID

var payload = ; // {OrganisationMembershipCollectionPayload} A backoffice organisation membership collection payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example // {String} 
};
api.backofficeOrganisationListMembership(id, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOrganisationListMembershipExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeOrganisationApi();
            var id = id_example;  // String | Organisation ID
            var payload = new OrganisationMembershipCollectionPayload(); // OrganisationMembershipCollectionPayload | A backoffice organisation membership collection payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // list_membership backoffice_organisation
                Organisation_membership_collection result = apiInstance.backofficeOrganisationListMembership(id, payload, acceptLanguage, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOrganisationApi.backofficeOrganisationListMembership: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeOrganisationApi();
$id = id_example; // String | Organisation ID
$payload = ; // OrganisationMembershipCollectionPayload | A backoffice organisation membership collection payload
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeOrganisationListMembership($id, $payload, $acceptLanguage, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeOrganisationApi->backofficeOrganisationListMembership: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeOrganisationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeOrganisationApi->new();
my $id = id_example; # String | Organisation ID
my $payload = WWW::SwaggerClient::Object::OrganisationMembershipCollectionPayload->new(); # OrganisationMembershipCollectionPayload | A backoffice organisation membership collection payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 

eval { 
    my $result = $api_instance->backofficeOrganisationListMembership(id => $id, payload => $payload, acceptLanguage => $acceptLanguage, organisation => $organisation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeOrganisationApi->backofficeOrganisationListMembership: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeOrganisationApi()
id = id_example # String | Organisation ID
payload =  # OrganisationMembershipCollectionPayload | A backoffice organisation membership collection payload
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)

try: 
    # list_membership backoffice_organisation
    api_response = api_instance.backoffice_organisation_list_membership(id, payload, acceptLanguage=acceptLanguage, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeOrganisationApi->backofficeOrganisationListMembership: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Organisation ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeOrganisationListPaymentMandates

list_payment_mandates backoffice_organisation

List new payment mandates


/0.0.1/backoffice/organisations/{id}/billing_settings/payment_mandates/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/organisations/{id}/billing_settings/payment_mandates/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOrganisationApi;

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

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Payment_mandate_collection result = apiInstance.backofficeOrganisationListPaymentMandates(id, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationListPaymentMandates");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOrganisationApi;

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Payment_mandate_collection result = apiInstance.backofficeOrganisationListPaymentMandates(id, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationListPaymentMandates");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Organisation ID
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)

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

// list_payment_mandates backoffice_organisation
[apiInstance backofficeOrganisationListPaymentMandatesWith:id
    acceptLanguage:acceptLanguage
    organisation:organisation
              completionHandler: ^(Payment_mandate_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeOrganisationApi()

var id = id_example; // {String} Organisation ID

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example // {String} 
};
api.backofficeOrganisationListPaymentMandates(id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOrganisationListPaymentMandatesExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeOrganisationApi();
            var id = id_example;  // String | Organisation ID
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // list_payment_mandates backoffice_organisation
                Payment_mandate_collection result = apiInstance.backofficeOrganisationListPaymentMandates(id, acceptLanguage, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOrganisationApi.backofficeOrganisationListPaymentMandates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeOrganisationApi();
$id = id_example; // String | Organisation ID
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeOrganisationListPaymentMandates($id, $acceptLanguage, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeOrganisationApi->backofficeOrganisationListPaymentMandates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeOrganisationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeOrganisationApi->new();
my $id = id_example; # String | Organisation ID
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeOrganisationApi()
id = id_example # String | Organisation ID
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)

try: 
    # list_payment_mandates backoffice_organisation
    api_response = api_instance.backoffice_organisation_list_payment_mandates(id, acceptLanguage=acceptLanguage, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeOrganisationApi->backofficeOrganisationListPaymentMandates: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Organisation ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeOrganisationListReplytoAddresses

list_replyto_addresses backoffice_organisation

List `reply to` addresses


/0.0.1/backoffice/organisations/{id}/email_settings/replyto_addresses

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/organisations/{id}/email_settings/replyto_addresses"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOrganisationApi;

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

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Email_replyto_address_collection result = apiInstance.backofficeOrganisationListReplytoAddresses(id, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationListReplytoAddresses");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOrganisationApi;

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Email_replyto_address_collection result = apiInstance.backofficeOrganisationListReplytoAddresses(id, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationListReplytoAddresses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Organisation ID
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)

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

// list_replyto_addresses backoffice_organisation
[apiInstance backofficeOrganisationListReplytoAddressesWith:id
    acceptLanguage:acceptLanguage
    organisation:organisation
              completionHandler: ^(Email_replyto_address_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeOrganisationApi()

var id = id_example; // {String} Organisation ID

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example // {String} 
};
api.backofficeOrganisationListReplytoAddresses(id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOrganisationListReplytoAddressesExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeOrganisationApi();
            var id = id_example;  // String | Organisation ID
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // list_replyto_addresses backoffice_organisation
                Email_replyto_address_collection result = apiInstance.backofficeOrganisationListReplytoAddresses(id, acceptLanguage, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOrganisationApi.backofficeOrganisationListReplytoAddresses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeOrganisationApi();
$id = id_example; // String | Organisation ID
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeOrganisationListReplytoAddresses($id, $acceptLanguage, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeOrganisationApi->backofficeOrganisationListReplytoAddresses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeOrganisationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeOrganisationApi->new();
my $id = id_example; # String | Organisation ID
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeOrganisationApi()
id = id_example # String | Organisation ID
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)

try: 
    # list_replyto_addresses backoffice_organisation
    api_response = api_instance.backoffice_organisation_list_replyto_addresses(id, acceptLanguage=acceptLanguage, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeOrganisationApi->backofficeOrganisationListReplytoAddresses: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Organisation ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeOrganisationShow

show backoffice_organisation

Retrieve organisation with given id.


/0.0.1/backoffice/organisations/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/organisations/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOrganisationApi;

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

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Organisation result = apiInstance.backofficeOrganisationShow(id, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOrganisationApi;

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Organisation result = apiInstance.backofficeOrganisationShow(id, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Organisation ID
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)

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

// show backoffice_organisation
[apiInstance backofficeOrganisationShowWith:id
    acceptLanguage:acceptLanguage
    organisation:organisation
              completionHandler: ^(Organisation output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeOrganisationApi()

var id = id_example; // {String} Organisation ID

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example // {String} 
};
api.backofficeOrganisationShow(id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOrganisationShowExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeOrganisationApi();
            var id = id_example;  // String | Organisation ID
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // show backoffice_organisation
                Organisation result = apiInstance.backofficeOrganisationShow(id, acceptLanguage, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOrganisationApi.backofficeOrganisationShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeOrganisationApi();
$id = id_example; // String | Organisation ID
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeOrganisationShow($id, $acceptLanguage, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeOrganisationApi->backofficeOrganisationShow: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeOrganisationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeOrganisationApi->new();
my $id = id_example; # String | Organisation ID
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeOrganisationApi()
id = id_example # String | Organisation ID
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)

try: 
    # show backoffice_organisation
    api_response = api_instance.backoffice_organisation_show(id, acceptLanguage=acceptLanguage, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeOrganisationApi->backofficeOrganisationShow: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Organisation ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeOrganisationShowLiveChatAutomationRuleActionLogItems

show_live_chat_automation_rule_action_log_items backoffice_organisation

Retrieve live chat automation rule action log items.


/0.0.1/backoffice/organisations/{id}/live_chat/automation_rule_action_log_items/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/organisations/{id}/live_chat/automation_rule_action_log_items/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOrganisationApi;

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

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        LiveChatAutomationRuleActionLogItemCollectionPayload payload = ; // LiveChatAutomationRuleActionLogItemCollectionPayload | Live chat automation rule action log item collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Live_chat_automation_rule_action_log_item_collection result = apiInstance.backofficeOrganisationShowLiveChatAutomationRuleActionLogItems(id, payload, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationShowLiveChatAutomationRuleActionLogItems");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOrganisationApi;

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        LiveChatAutomationRuleActionLogItemCollectionPayload payload = ; // LiveChatAutomationRuleActionLogItemCollectionPayload | Live chat automation rule action log item collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Live_chat_automation_rule_action_log_item_collection result = apiInstance.backofficeOrganisationShowLiveChatAutomationRuleActionLogItems(id, payload, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationShowLiveChatAutomationRuleActionLogItems");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Organisation ID
LiveChatAutomationRuleActionLogItemCollectionPayload *payload = ; // Live chat automation rule action log item collection payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)

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

// show_live_chat_automation_rule_action_log_items backoffice_organisation
[apiInstance backofficeOrganisationShowLiveChatAutomationRuleActionLogItemsWith:id
    payload:payload
    acceptLanguage:acceptLanguage
    organisation:organisation
              completionHandler: ^(Live_chat_automation_rule_action_log_item_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeOrganisationApi()

var id = id_example; // {String} Organisation ID

var payload = ; // {LiveChatAutomationRuleActionLogItemCollectionPayload} Live chat automation rule action log item collection payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example // {String} 
};
api.backofficeOrganisationShowLiveChatAutomationRuleActionLogItems(id, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOrganisationShowLiveChatAutomationRuleActionLogItemsExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeOrganisationApi();
            var id = id_example;  // String | Organisation ID
            var payload = new LiveChatAutomationRuleActionLogItemCollectionPayload(); // LiveChatAutomationRuleActionLogItemCollectionPayload | Live chat automation rule action log item collection payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // show_live_chat_automation_rule_action_log_items backoffice_organisation
                Live_chat_automation_rule_action_log_item_collection result = apiInstance.backofficeOrganisationShowLiveChatAutomationRuleActionLogItems(id, payload, acceptLanguage, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOrganisationApi.backofficeOrganisationShowLiveChatAutomationRuleActionLogItems: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeOrganisationApi();
$id = id_example; // String | Organisation ID
$payload = ; // LiveChatAutomationRuleActionLogItemCollectionPayload | Live chat automation rule action log item collection payload
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeOrganisationShowLiveChatAutomationRuleActionLogItems($id, $payload, $acceptLanguage, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeOrganisationApi->backofficeOrganisationShowLiveChatAutomationRuleActionLogItems: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeOrganisationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeOrganisationApi->new();
my $id = id_example; # String | Organisation ID
my $payload = WWW::SwaggerClient::Object::LiveChatAutomationRuleActionLogItemCollectionPayload->new(); # LiveChatAutomationRuleActionLogItemCollectionPayload | Live chat automation rule action log item collection payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 

eval { 
    my $result = $api_instance->backofficeOrganisationShowLiveChatAutomationRuleActionLogItems(id => $id, payload => $payload, acceptLanguage => $acceptLanguage, organisation => $organisation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeOrganisationApi->backofficeOrganisationShowLiveChatAutomationRuleActionLogItems: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeOrganisationApi()
id = id_example # String | Organisation ID
payload =  # LiveChatAutomationRuleActionLogItemCollectionPayload | Live chat automation rule action log item collection payload
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)

try: 
    # show_live_chat_automation_rule_action_log_items backoffice_organisation
    api_response = api_instance.backoffice_organisation_show_live_chat_automation_rule_action_log_items(id, payload, acceptLanguage=acceptLanguage, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeOrganisationApi->backofficeOrganisationShowLiveChatAutomationRuleActionLogItems: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Organisation ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeOrganisationUpdate

update backoffice_organisation

Change organisation


/0.0.1/backoffice/organisations/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/organisations/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOrganisationApi;

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

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        OrganisationUpdatePayload payload = ; // OrganisationUpdatePayload | Organisation update payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Organisation result = apiInstance.backofficeOrganisationUpdate(id, payload, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOrganisationApi;

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        OrganisationUpdatePayload payload = ; // OrganisationUpdatePayload | Organisation update payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Organisation result = apiInstance.backofficeOrganisationUpdate(id, payload, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Organisation ID
OrganisationUpdatePayload *payload = ; // Organisation update payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)

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

// update backoffice_organisation
[apiInstance backofficeOrganisationUpdateWith:id
    payload:payload
    acceptLanguage:acceptLanguage
    organisation:organisation
              completionHandler: ^(Organisation output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeOrganisationApi()

var id = id_example; // {String} Organisation ID

var payload = ; // {OrganisationUpdatePayload} Organisation update payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example // {String} 
};
api.backofficeOrganisationUpdate(id, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOrganisationUpdateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeOrganisationApi();
            var id = id_example;  // String | Organisation ID
            var payload = new OrganisationUpdatePayload(); // OrganisationUpdatePayload | Organisation update payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // update backoffice_organisation
                Organisation result = apiInstance.backofficeOrganisationUpdate(id, payload, acceptLanguage, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOrganisationApi.backofficeOrganisationUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeOrganisationApi();
$id = id_example; // String | Organisation ID
$payload = ; // OrganisationUpdatePayload | Organisation update payload
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeOrganisationUpdate($id, $payload, $acceptLanguage, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeOrganisationApi->backofficeOrganisationUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeOrganisationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeOrganisationApi->new();
my $id = id_example; # String | Organisation ID
my $payload = WWW::SwaggerClient::Object::OrganisationUpdatePayload->new(); # OrganisationUpdatePayload | Organisation update payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 

eval { 
    my $result = $api_instance->backofficeOrganisationUpdate(id => $id, payload => $payload, acceptLanguage => $acceptLanguage, organisation => $organisation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeOrganisationApi->backofficeOrganisationUpdate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeOrganisationApi()
id = id_example # String | Organisation ID
payload =  # OrganisationUpdatePayload | Organisation update payload
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)

try: 
    # update backoffice_organisation
    api_response = api_instance.backoffice_organisation_update(id, payload, acceptLanguage=acceptLanguage, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeOrganisationApi->backofficeOrganisationUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Organisation ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeOrganisationUpdateFromAddress

update_from_address backoffice_organisation

Update `from` address


/0.0.1/backoffice/organisations/{id}/email_settings/from_addresses/{address_id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/organisations/{id}/email_settings/from_addresses/{address_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOrganisationApi;

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

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String addressId = addressId_example; // String | Address ID
        String id = id_example; // String | Organisation ID
        EmailAddressUpdatePayload payload = ; // EmailAddressUpdatePayload | Email address update payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Email_from_address result = apiInstance.backofficeOrganisationUpdateFromAddress(addressId, id, payload, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationUpdateFromAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOrganisationApi;

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String addressId = addressId_example; // String | Address ID
        String id = id_example; // String | Organisation ID
        EmailAddressUpdatePayload payload = ; // EmailAddressUpdatePayload | Email address update payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            Email_from_address result = apiInstance.backofficeOrganisationUpdateFromAddress(addressId, id, payload, acceptLanguage, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationUpdateFromAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *addressId = addressId_example; // Address ID
String *id = id_example; // Organisation ID
EmailAddressUpdatePayload *payload = ; // Email address update payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)

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

// update_from_address backoffice_organisation
[apiInstance backofficeOrganisationUpdateFromAddressWith:addressId
    id:id
    payload:payload
    acceptLanguage:acceptLanguage
    organisation:organisation
              completionHandler: ^(Email_from_address output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeOrganisationApi()

var addressId = addressId_example; // {String} Address ID

var id = id_example; // {String} Organisation ID

var payload = ; // {EmailAddressUpdatePayload} Email address update payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example // {String} 
};
api.backofficeOrganisationUpdateFromAddress(addressId, id, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOrganisationUpdateFromAddressExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeOrganisationApi();
            var addressId = addressId_example;  // String | Address ID
            var id = id_example;  // String | Organisation ID
            var payload = new EmailAddressUpdatePayload(); // EmailAddressUpdatePayload | Email address update payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // update_from_address backoffice_organisation
                Email_from_address result = apiInstance.backofficeOrganisationUpdateFromAddress(addressId, id, payload, acceptLanguage, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOrganisationApi.backofficeOrganisationUpdateFromAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeOrganisationApi();
$addressId = addressId_example; // String | Address ID
$id = id_example; // String | Organisation ID
$payload = ; // EmailAddressUpdatePayload | Email address update payload
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeOrganisationUpdateFromAddress($addressId, $id, $payload, $acceptLanguage, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeOrganisationApi->backofficeOrganisationUpdateFromAddress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeOrganisationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeOrganisationApi->new();
my $addressId = addressId_example; # String | Address ID
my $id = id_example; # String | Organisation ID
my $payload = WWW::SwaggerClient::Object::EmailAddressUpdatePayload->new(); # EmailAddressUpdatePayload | Email address update payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 

eval { 
    my $result = $api_instance->backofficeOrganisationUpdateFromAddress(addressId => $addressId, id => $id, payload => $payload, acceptLanguage => $acceptLanguage, organisation => $organisation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeOrganisationApi->backofficeOrganisationUpdateFromAddress: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeOrganisationApi()
addressId = addressId_example # String | Address ID
id = id_example # String | Organisation ID
payload =  # EmailAddressUpdatePayload | Email address update payload
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)

try: 
    # update_from_address backoffice_organisation
    api_response = api_instance.backoffice_organisation_update_from_address(addressId, id, payload, acceptLanguage=acceptLanguage, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeOrganisationApi->backofficeOrganisationUpdateFromAddress: %s\n" % e)

Parameters

Path parameters
Name Description
address_id*
String
Address ID
Required
id*
String
Organisation ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeOrganisationUpdateMembership

update_membership backoffice_organisation

Update membership


/0.0.1/backoffice/organisations/{id}/membership/{membership_id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/organisations/{id}/membership/{membership_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOrganisationApi;

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

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        String membershipId = membershipId_example; // String | Membership ID
        OrganisationMembershipUpdatePayload payload = ; // OrganisationMembershipUpdatePayload | Organisation membership update payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeOrganisationUpdateMembership(id, membershipId, payload, acceptLanguage, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationUpdateMembership");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOrganisationApi;

public class BackofficeOrganisationApiExample {

    public static void main(String[] args) {
        BackofficeOrganisationApi apiInstance = new BackofficeOrganisationApi();
        String id = id_example; // String | Organisation ID
        String membershipId = membershipId_example; // String | Membership ID
        OrganisationMembershipUpdatePayload payload = ; // OrganisationMembershipUpdatePayload | Organisation membership update payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeOrganisationUpdateMembership(id, membershipId, payload, acceptLanguage, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationApi#backofficeOrganisationUpdateMembership");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Organisation ID
String *membershipId = membershipId_example; // Membership ID
OrganisationMembershipUpdatePayload *payload = ; // Organisation membership update payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)

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

// update_membership backoffice_organisation
[apiInstance backofficeOrganisationUpdateMembershipWith:id
    membershipId:membershipId
    payload:payload
    acceptLanguage:acceptLanguage
    organisation:organisation
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeOrganisationApi()

var id = id_example; // {String} Organisation ID

var membershipId = membershipId_example; // {String} Membership ID

var payload = ; // {OrganisationMembershipUpdatePayload} Organisation membership update payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example // {String} 
};
api.backofficeOrganisationUpdateMembership(id, membershipId, payload, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOrganisationUpdateMembershipExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeOrganisationApi();
            var id = id_example;  // String | Organisation ID
            var membershipId = membershipId_example;  // String | Membership ID
            var payload = new OrganisationMembershipUpdatePayload(); // OrganisationMembershipUpdatePayload | Organisation membership update payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // update_membership backoffice_organisation
                apiInstance.backofficeOrganisationUpdateMembership(id, membershipId, payload, acceptLanguage, organisation);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOrganisationApi.backofficeOrganisationUpdateMembership: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeOrganisationApi();
$id = id_example; // String | Organisation ID
$membershipId = membershipId_example; // String | Membership ID
$payload = ; // OrganisationMembershipUpdatePayload | Organisation membership update payload
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 

try {
    $api_instance->backofficeOrganisationUpdateMembership($id, $membershipId, $payload, $acceptLanguage, $organisation);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeOrganisationApi->backofficeOrganisationUpdateMembership: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeOrganisationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeOrganisationApi->new();
my $id = id_example; # String | Organisation ID
my $membershipId = membershipId_example; # String | Membership ID
my $payload = WWW::SwaggerClient::Object::OrganisationMembershipUpdatePayload->new(); # OrganisationMembershipUpdatePayload | Organisation membership update payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 

eval { 
    $api_instance->backofficeOrganisationUpdateMembership(id => $id, membershipId => $membershipId, payload => $payload, acceptLanguage => $acceptLanguage, organisation => $organisation);
};
if ($@) {
    warn "Exception when calling BackofficeOrganisationApi->backofficeOrganisationUpdateMembership: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeOrganisationApi()
id = id_example # String | Organisation ID
membershipId = membershipId_example # String | Membership ID
payload =  # OrganisationMembershipUpdatePayload | Organisation membership update payload
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)

try: 
    # update_membership backoffice_organisation
    api_instance.backoffice_organisation_update_membership(id, membershipId, payload, acceptLanguage=acceptLanguage, organisation=organisation)
except ApiException as e:
    print("Exception when calling BackofficeOrganisationApi->backofficeOrganisationUpdateMembership: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Organisation ID
Required
membership_id*
String
Membership ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


BackofficeOrganisationReferral

backofficeOrganisationReferralCreatePayment

create_payment backoffice_organisation_referral

Create an organisation referral payment for given organisation.


/0.0.1/backoffice/organisation_referrals/{id}/payments

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/organisation_referrals/{id}/payments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOrganisationReferralApi;

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

public class BackofficeOrganisationReferralApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeOrganisationReferralApi apiInstance = new BackofficeOrganisationReferralApi();
        String id = id_example; // String | Organisation ID
        OrganisationReferralPaymentPayload payload = ; // OrganisationReferralPaymentPayload | An organisation referral payment payload
        String organisation = organisation_example; // String | 
        try {
            Organisation_referral_payment result = apiInstance.backofficeOrganisationReferralCreatePayment(id, payload, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationReferralApi#backofficeOrganisationReferralCreatePayment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOrganisationReferralApi;

public class BackofficeOrganisationReferralApiExample {

    public static void main(String[] args) {
        BackofficeOrganisationReferralApi apiInstance = new BackofficeOrganisationReferralApi();
        String id = id_example; // String | Organisation ID
        OrganisationReferralPaymentPayload payload = ; // OrganisationReferralPaymentPayload | An organisation referral payment payload
        String organisation = organisation_example; // String | 
        try {
            Organisation_referral_payment result = apiInstance.backofficeOrganisationReferralCreatePayment(id, payload, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationReferralApi#backofficeOrganisationReferralCreatePayment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Organisation ID
OrganisationReferralPaymentPayload *payload = ; // An organisation referral payment payload
String *organisation = organisation_example; //  (optional)

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

// create_payment backoffice_organisation_referral
[apiInstance backofficeOrganisationReferralCreatePaymentWith:id
    payload:payload
    organisation:organisation
              completionHandler: ^(Organisation_referral_payment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeOrganisationReferralApi()

var id = id_example; // {String} Organisation ID

var payload = ; // {OrganisationReferralPaymentPayload} An organisation referral payment payload

var opts = { 
  'organisation': organisation_example // {String} 
};
api.backofficeOrganisationReferralCreatePayment(id, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOrganisationReferralCreatePaymentExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeOrganisationReferralApi();
            var id = id_example;  // String | Organisation ID
            var payload = new OrganisationReferralPaymentPayload(); // OrganisationReferralPaymentPayload | An organisation referral payment payload
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // create_payment backoffice_organisation_referral
                Organisation_referral_payment result = apiInstance.backofficeOrganisationReferralCreatePayment(id, payload, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOrganisationReferralApi.backofficeOrganisationReferralCreatePayment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeOrganisationReferralApi();
$id = id_example; // String | Organisation ID
$payload = ; // OrganisationReferralPaymentPayload | An organisation referral payment payload
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeOrganisationReferralCreatePayment($id, $payload, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeOrganisationReferralApi->backofficeOrganisationReferralCreatePayment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeOrganisationReferralApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeOrganisationReferralApi->new();
my $id = id_example; # String | Organisation ID
my $payload = WWW::SwaggerClient::Object::OrganisationReferralPaymentPayload->new(); # OrganisationReferralPaymentPayload | An organisation referral payment payload
my $organisation = organisation_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeOrganisationReferralApi()
id = id_example # String | Organisation ID
payload =  # OrganisationReferralPaymentPayload | An organisation referral payment payload
organisation = organisation_example # String |  (optional)

try: 
    # create_payment backoffice_organisation_referral
    api_response = api_instance.backoffice_organisation_referral_create_payment(id, payload, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeOrganisationReferralApi->backofficeOrganisationReferralCreatePayment: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Organisation ID
Required
Header parameters
Name Description
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeOrganisationReferralListPayments

list_payments backoffice_organisation_referral

Retrieve organisation referral payments for given organisation.


/0.0.1/backoffice/organisation_referrals/{id}/payments/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/organisation_referrals/{id}/payments/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOrganisationReferralApi;

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

public class BackofficeOrganisationReferralApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeOrganisationReferralApi apiInstance = new BackofficeOrganisationReferralApi();
        String id = id_example; // String | Organisation ID
        OrganisationReferralPaymentCollectionPayload payload = ; // OrganisationReferralPaymentCollectionPayload | A backoffice organisation referral payment collection payload
        String organisation = organisation_example; // String | 
        try {
            Organisation_referral_payment_collection result = apiInstance.backofficeOrganisationReferralListPayments(id, payload, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationReferralApi#backofficeOrganisationReferralListPayments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOrganisationReferralApi;

public class BackofficeOrganisationReferralApiExample {

    public static void main(String[] args) {
        BackofficeOrganisationReferralApi apiInstance = new BackofficeOrganisationReferralApi();
        String id = id_example; // String | Organisation ID
        OrganisationReferralPaymentCollectionPayload payload = ; // OrganisationReferralPaymentCollectionPayload | A backoffice organisation referral payment collection payload
        String organisation = organisation_example; // String | 
        try {
            Organisation_referral_payment_collection result = apiInstance.backofficeOrganisationReferralListPayments(id, payload, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationReferralApi#backofficeOrganisationReferralListPayments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Organisation ID
OrganisationReferralPaymentCollectionPayload *payload = ; // A backoffice organisation referral payment collection payload
String *organisation = organisation_example; //  (optional)

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

// list_payments backoffice_organisation_referral
[apiInstance backofficeOrganisationReferralListPaymentsWith:id
    payload:payload
    organisation:organisation
              completionHandler: ^(Organisation_referral_payment_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeOrganisationReferralApi()

var id = id_example; // {String} Organisation ID

var payload = ; // {OrganisationReferralPaymentCollectionPayload} A backoffice organisation referral payment collection payload

var opts = { 
  'organisation': organisation_example // {String} 
};
api.backofficeOrganisationReferralListPayments(id, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOrganisationReferralListPaymentsExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeOrganisationReferralApi();
            var id = id_example;  // String | Organisation ID
            var payload = new OrganisationReferralPaymentCollectionPayload(); // OrganisationReferralPaymentCollectionPayload | A backoffice organisation referral payment collection payload
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // list_payments backoffice_organisation_referral
                Organisation_referral_payment_collection result = apiInstance.backofficeOrganisationReferralListPayments(id, payload, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOrganisationReferralApi.backofficeOrganisationReferralListPayments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeOrganisationReferralApi();
$id = id_example; // String | Organisation ID
$payload = ; // OrganisationReferralPaymentCollectionPayload | A backoffice organisation referral payment collection payload
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeOrganisationReferralListPayments($id, $payload, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeOrganisationReferralApi->backofficeOrganisationReferralListPayments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeOrganisationReferralApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeOrganisationReferralApi->new();
my $id = id_example; # String | Organisation ID
my $payload = WWW::SwaggerClient::Object::OrganisationReferralPaymentCollectionPayload->new(); # OrganisationReferralPaymentCollectionPayload | A backoffice organisation referral payment collection payload
my $organisation = organisation_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeOrganisationReferralApi()
id = id_example # String | Organisation ID
payload =  # OrganisationReferralPaymentCollectionPayload | A backoffice organisation referral payment collection payload
organisation = organisation_example # String |  (optional)

try: 
    # list_payments backoffice_organisation_referral
    api_response = api_instance.backoffice_organisation_referral_list_payments(id, payload, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeOrganisationReferralApi->backofficeOrganisationReferralListPayments: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Organisation ID
Required
Header parameters
Name Description
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeOrganisationReferralShow

show backoffice_organisation_referral

Retrieve organisation referral for given organisation.


/0.0.1/backoffice/organisation_referrals/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/organisation_referrals/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeOrganisationReferralApi;

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

public class BackofficeOrganisationReferralApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeOrganisationReferralApi apiInstance = new BackofficeOrganisationReferralApi();
        String id = id_example; // String | Organisation ID
        String organisation = organisation_example; // String | 
        try {
            Organisation_referral result = apiInstance.backofficeOrganisationReferralShow(id, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationReferralApi#backofficeOrganisationReferralShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeOrganisationReferralApi;

public class BackofficeOrganisationReferralApiExample {

    public static void main(String[] args) {
        BackofficeOrganisationReferralApi apiInstance = new BackofficeOrganisationReferralApi();
        String id = id_example; // String | Organisation ID
        String organisation = organisation_example; // String | 
        try {
            Organisation_referral result = apiInstance.backofficeOrganisationReferralShow(id, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeOrganisationReferralApi#backofficeOrganisationReferralShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Organisation ID
String *organisation = organisation_example; //  (optional)

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

// show backoffice_organisation_referral
[apiInstance backofficeOrganisationReferralShowWith:id
    organisation:organisation
              completionHandler: ^(Organisation_referral output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeOrganisationReferralApi()

var id = id_example; // {String} Organisation ID

var opts = { 
  'organisation': organisation_example // {String} 
};
api.backofficeOrganisationReferralShow(id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeOrganisationReferralShowExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeOrganisationReferralApi();
            var id = id_example;  // String | Organisation ID
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // show backoffice_organisation_referral
                Organisation_referral result = apiInstance.backofficeOrganisationReferralShow(id, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeOrganisationReferralApi.backofficeOrganisationReferralShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeOrganisationReferralApi();
$id = id_example; // String | Organisation ID
$organisation = organisation_example; // String | 

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

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeOrganisationReferralApi->new();
my $id = id_example; # String | Organisation ID
my $organisation = organisation_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeOrganisationReferralApi()
id = id_example # String | Organisation ID
organisation = organisation_example # String |  (optional)

try: 
    # show backoffice_organisation_referral
    api_response = api_instance.backoffice_organisation_referral_show(id, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeOrganisationReferralApi->backofficeOrganisationReferralShow: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Organisation ID
Required
Header parameters
Name Description
Organisation
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


BackofficePassword

backofficePasswordScore

score backoffice_password

Get password score


/0.0.1/backoffice/passwords

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/backoffice/passwords"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficePasswordApi;

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

public class BackofficePasswordApiExample {

    public static void main(String[] args) {
        
        BackofficePasswordApi apiInstance = new BackofficePasswordApi();
        PasswordScorePayload payload = ; // PasswordScorePayload | Password score payload
        try {
            Password_score result = apiInstance.backofficePasswordScore(payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficePasswordApi#backofficePasswordScore");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficePasswordApi;

public class BackofficePasswordApiExample {

    public static void main(String[] args) {
        BackofficePasswordApi apiInstance = new BackofficePasswordApi();
        PasswordScorePayload payload = ; // PasswordScorePayload | Password score payload
        try {
            Password_score result = apiInstance.backofficePasswordScore(payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficePasswordApi#backofficePasswordScore");
            e.printStackTrace();
        }
    }
}
PasswordScorePayload *payload = ; // Password score payload

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

// score backoffice_password
[apiInstance backofficePasswordScoreWith:payload
              completionHandler: ^(Password_score output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.BackofficePasswordApi()

var payload = ; // {PasswordScorePayload} Password score payload

api.backofficePasswordScore(payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficePasswordScoreExample
    {
        public void main()
        {
            
            var apiInstance = new BackofficePasswordApi();
            var payload = new PasswordScorePayload(); // PasswordScorePayload | Password score payload

            try
            {
                // score backoffice_password
                Password_score result = apiInstance.backofficePasswordScore(payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficePasswordApi.backofficePasswordScore: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BackofficePasswordApi();
$payload = ; // PasswordScorePayload | Password score payload

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

my $api_instance = WWW::SwaggerClient::BackofficePasswordApi->new();
my $payload = WWW::SwaggerClient::Object::PasswordScorePayload->new(); # PasswordScorePayload | Password score payload

eval { 
    my $result = $api_instance->backofficePasswordScore(payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficePasswordApi->backofficePasswordScore: $@\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.BackofficePasswordApi()
payload =  # PasswordScorePayload | Password score payload

try: 
    # score backoffice_password
    api_response = api_instance.backoffice_password_score(payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficePasswordApi->backofficePasswordScore: %s\n" % e)

Parameters

Body parameters
Name Description
payload *

Responses

Status: 200 - OK


BackofficePayment

backofficePaymentFinish

finish backoffice_payment

Finish the payment process.


/0.0.1/backoffice/payments/{id}/finish

Usage and SDK Samples

curl -X GET "https://api.quriobot.com/0.0.1/backoffice/payments/{id}/finish"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficePaymentApi;

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

public class BackofficePaymentApiExample {

    public static void main(String[] args) {
        
        BackofficePaymentApi apiInstance = new BackofficePaymentApi();
        String id = id_example; // String | Payment ID
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficePaymentFinish(id, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficePaymentApi#backofficePaymentFinish");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficePaymentApi;

public class BackofficePaymentApiExample {

    public static void main(String[] args) {
        BackofficePaymentApi apiInstance = new BackofficePaymentApi();
        String id = id_example; // String | Payment ID
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficePaymentFinish(id, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficePaymentApi#backofficePaymentFinish");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Payment ID
String *organisation = organisation_example; //  (optional)

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

// finish backoffice_payment
[apiInstance backofficePaymentFinishWith:id
    organisation:organisation
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.BackofficePaymentApi()

var id = id_example; // {String} Payment ID

var opts = { 
  'organisation': organisation_example // {String} 
};
api.backofficePaymentFinish(id, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficePaymentFinishExample
    {
        public void main()
        {
            
            var apiInstance = new BackofficePaymentApi();
            var id = id_example;  // String | Payment ID
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // finish backoffice_payment
                apiInstance.backofficePaymentFinish(id, organisation);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficePaymentApi.backofficePaymentFinish: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BackofficePaymentApi();
$id = id_example; // String | Payment ID
$organisation = organisation_example; // String | 

try {
    $api_instance->backofficePaymentFinish($id, $organisation);
} catch (Exception $e) {
    echo 'Exception when calling BackofficePaymentApi->backofficePaymentFinish: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficePaymentApi;

my $api_instance = WWW::SwaggerClient::BackofficePaymentApi->new();
my $id = id_example; # String | Payment ID
my $organisation = organisation_example; # String | 

eval { 
    $api_instance->backofficePaymentFinish(id => $id, organisation => $organisation);
};
if ($@) {
    warn "Exception when calling BackofficePaymentApi->backofficePaymentFinish: $@\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.BackofficePaymentApi()
id = id_example # String | Payment ID
organisation = organisation_example # String |  (optional)

try: 
    # finish backoffice_payment
    api_instance.backoffice_payment_finish(id, organisation=organisation)
except ApiException as e:
    print("Exception when calling BackofficePaymentApi->backofficePaymentFinish: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Payment ID
Required
Header parameters
Name Description
Organisation
String

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficePaymentList

list backoffice_payment

Retrieve all payments.


/0.0.1/backoffice/payments/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/payments/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficePaymentApi;

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

public class BackofficePaymentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficePaymentApi apiInstance = new BackofficePaymentApi();
        PaymentCollectionPayload payload = ; // PaymentCollectionPayload | Payment collection payload
        String organisation = organisation_example; // String | 
        try {
            Payment_collection result = apiInstance.backofficePaymentList(payload, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficePaymentApi#backofficePaymentList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficePaymentApi;

public class BackofficePaymentApiExample {

    public static void main(String[] args) {
        BackofficePaymentApi apiInstance = new BackofficePaymentApi();
        PaymentCollectionPayload payload = ; // PaymentCollectionPayload | Payment collection payload
        String organisation = organisation_example; // String | 
        try {
            Payment_collection result = apiInstance.backofficePaymentList(payload, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficePaymentApi#backofficePaymentList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

PaymentCollectionPayload *payload = ; // Payment collection payload
String *organisation = organisation_example; //  (optional)

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

// list backoffice_payment
[apiInstance backofficePaymentListWith:payload
    organisation:organisation
              completionHandler: ^(Payment_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficePaymentApi()

var payload = ; // {PaymentCollectionPayload} Payment collection payload

var opts = { 
  'organisation': organisation_example // {String} 
};
api.backofficePaymentList(payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficePaymentListExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficePaymentApi();
            var payload = new PaymentCollectionPayload(); // PaymentCollectionPayload | Payment collection payload
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // list backoffice_payment
                Payment_collection result = apiInstance.backofficePaymentList(payload, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficePaymentApi.backofficePaymentList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficePaymentApi();
$payload = ; // PaymentCollectionPayload | Payment collection payload
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficePaymentList($payload, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficePaymentApi->backofficePaymentList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficePaymentApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficePaymentApi->new();
my $payload = WWW::SwaggerClient::Object::PaymentCollectionPayload->new(); # PaymentCollectionPayload | Payment collection payload
my $organisation = organisation_example; # String | 

eval { 
    my $result = $api_instance->backofficePaymentList(payload => $payload, organisation => $organisation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficePaymentApi->backofficePaymentList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficePaymentApi()
payload =  # PaymentCollectionPayload | Payment collection payload
organisation = organisation_example # String |  (optional)

try: 
    # list backoffice_payment
    api_response = api_instance.backoffice_payment_list(payload, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficePaymentApi->backofficePaymentList: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficePaymentShow

show backoffice_payment

Retrieve payment with given id.


/0.0.1/backoffice/payments/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/payments/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficePaymentApi;

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

public class BackofficePaymentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficePaymentApi apiInstance = new BackofficePaymentApi();
        String id = id_example; // String | Payment ID
        String organisation = organisation_example; // String | 
        try {
            Payment result = apiInstance.backofficePaymentShow(id, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficePaymentApi#backofficePaymentShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficePaymentApi;

public class BackofficePaymentApiExample {

    public static void main(String[] args) {
        BackofficePaymentApi apiInstance = new BackofficePaymentApi();
        String id = id_example; // String | Payment ID
        String organisation = organisation_example; // String | 
        try {
            Payment result = apiInstance.backofficePaymentShow(id, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficePaymentApi#backofficePaymentShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Payment ID
String *organisation = organisation_example; //  (optional)

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

// show backoffice_payment
[apiInstance backofficePaymentShowWith:id
    organisation:organisation
              completionHandler: ^(Payment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficePaymentApi()

var id = id_example; // {String} Payment ID

var opts = { 
  'organisation': organisation_example // {String} 
};
api.backofficePaymentShow(id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficePaymentShowExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficePaymentApi();
            var id = id_example;  // String | Payment ID
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // show backoffice_payment
                Payment result = apiInstance.backofficePaymentShow(id, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficePaymentApi.backofficePaymentShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficePaymentApi();
$id = id_example; // String | Payment ID
$organisation = organisation_example; // String | 

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

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficePaymentApi->new();
my $id = id_example; # String | Payment ID
my $organisation = organisation_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficePaymentApi()
id = id_example # String | Payment ID
organisation = organisation_example # String |  (optional)

try: 
    # show backoffice_payment
    api_response = api_instance.backoffice_payment_show(id, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficePaymentApi->backofficePaymentShow: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Payment ID
Required
Header parameters
Name Description
Organisation
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficePaymentUpdateStatus

update_status backoffice_payment

Retrieve payment status from the provider.


/0.0.1/backoffice/payments/status

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/backoffice/payments/status"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficePaymentApi;

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

public class BackofficePaymentApiExample {

    public static void main(String[] args) {
        
        BackofficePaymentApi apiInstance = new BackofficePaymentApi();
        PaymentUpdateStatusPayload payload = ; // PaymentUpdateStatusPayload | Payment update status payload
        String organisation = organisation_example; // String | 
        try {
            Payment result = apiInstance.backofficePaymentUpdateStatus(payload, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficePaymentApi#backofficePaymentUpdateStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficePaymentApi;

public class BackofficePaymentApiExample {

    public static void main(String[] args) {
        BackofficePaymentApi apiInstance = new BackofficePaymentApi();
        PaymentUpdateStatusPayload payload = ; // PaymentUpdateStatusPayload | Payment update status payload
        String organisation = organisation_example; // String | 
        try {
            Payment result = apiInstance.backofficePaymentUpdateStatus(payload, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficePaymentApi#backofficePaymentUpdateStatus");
            e.printStackTrace();
        }
    }
}
PaymentUpdateStatusPayload *payload = ; // Payment update status payload
String *organisation = organisation_example; //  (optional)

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

// update_status backoffice_payment
[apiInstance backofficePaymentUpdateStatusWith:payload
    organisation:organisation
              completionHandler: ^(Payment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.BackofficePaymentApi()

var payload = ; // {PaymentUpdateStatusPayload} Payment update status payload

var opts = { 
  'organisation': organisation_example // {String} 
};
api.backofficePaymentUpdateStatus(payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficePaymentUpdateStatusExample
    {
        public void main()
        {
            
            var apiInstance = new BackofficePaymentApi();
            var payload = new PaymentUpdateStatusPayload(); // PaymentUpdateStatusPayload | Payment update status payload
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // update_status backoffice_payment
                Payment result = apiInstance.backofficePaymentUpdateStatus(payload, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficePaymentApi.backofficePaymentUpdateStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BackofficePaymentApi();
$payload = ; // PaymentUpdateStatusPayload | Payment update status payload
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficePaymentUpdateStatus($payload, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficePaymentApi->backofficePaymentUpdateStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficePaymentApi;

my $api_instance = WWW::SwaggerClient::BackofficePaymentApi->new();
my $payload = WWW::SwaggerClient::Object::PaymentUpdateStatusPayload->new(); # PaymentUpdateStatusPayload | Payment update status payload
my $organisation = organisation_example; # String | 

eval { 
    my $result = $api_instance->backofficePaymentUpdateStatus(payload => $payload, organisation => $organisation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficePaymentApi->backofficePaymentUpdateStatus: $@\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.BackofficePaymentApi()
payload =  # PaymentUpdateStatusPayload | Payment update status payload
organisation = organisation_example # String |  (optional)

try: 
    # update_status backoffice_payment
    api_response = api_instance.backoffice_payment_update_status(payload, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficePaymentApi->backofficePaymentUpdateStatus: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficePaymentUpdateStatuses

update_statuses backoffice_payment

Schedule an update of payment statuses.


/0.0.1/backoffice/payments/update_status

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/payments/update_status"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficePaymentApi;

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

public class BackofficePaymentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficePaymentApi apiInstance = new BackofficePaymentApi();
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficePaymentUpdateStatuses(organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficePaymentApi#backofficePaymentUpdateStatuses");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficePaymentApi;

public class BackofficePaymentApiExample {

    public static void main(String[] args) {
        BackofficePaymentApi apiInstance = new BackofficePaymentApi();
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficePaymentUpdateStatuses(organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficePaymentApi#backofficePaymentUpdateStatuses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; //  (optional)

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

// update_statuses backoffice_payment
[apiInstance backofficePaymentUpdateStatusesWith:organisation
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficePaymentApi()

var opts = { 
  'organisation': organisation_example // {String} 
};
api.backofficePaymentUpdateStatuses(opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficePaymentUpdateStatusesExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficePaymentApi();
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // update_statuses backoffice_payment
                apiInstance.backofficePaymentUpdateStatuses(organisation);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficePaymentApi.backofficePaymentUpdateStatuses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficePaymentApi();
$organisation = organisation_example; // String | 

try {
    $api_instance->backofficePaymentUpdateStatuses($organisation);
} catch (Exception $e) {
    echo 'Exception when calling BackofficePaymentApi->backofficePaymentUpdateStatuses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficePaymentApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficePaymentApi->new();
my $organisation = organisation_example; # String | 

eval { 
    $api_instance->backofficePaymentUpdateStatuses(organisation => $organisation);
};
if ($@) {
    warn "Exception when calling BackofficePaymentApi->backofficePaymentUpdateStatuses: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficePaymentApi()
organisation = organisation_example # String |  (optional)

try: 
    # update_statuses backoffice_payment
    api_instance.backoffice_payment_update_statuses(organisation=organisation)
except ApiException as e:
    print("Exception when calling BackofficePaymentApi->backofficePaymentUpdateStatuses: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation
String

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden


BackofficeRegistration

backofficeRegistrationConfirm

confirm backoffice_registration

Confirm backoffice user registration


/0.0.1/backoffice/bouser_registrations/confirm

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/backoffice/bouser_registrations/confirm"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeRegistrationApi;

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

public class BackofficeRegistrationApiExample {

    public static void main(String[] args) {
        
        BackofficeRegistrationApi apiInstance = new BackofficeRegistrationApi();
        BoUserRegistrationConfirmationPayload payload = ; // BoUserRegistrationConfirmationPayload | A backoffice user registration confirmation payload
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user result = apiInstance.backofficeRegistrationConfirm(payload, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeRegistrationApi#backofficeRegistrationConfirm");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeRegistrationApi;

public class BackofficeRegistrationApiExample {

    public static void main(String[] args) {
        BackofficeRegistrationApi apiInstance = new BackofficeRegistrationApi();
        BoUserRegistrationConfirmationPayload payload = ; // BoUserRegistrationConfirmationPayload | A backoffice user registration confirmation payload
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Bo_user result = apiInstance.backofficeRegistrationConfirm(payload, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeRegistrationApi#backofficeRegistrationConfirm");
            e.printStackTrace();
        }
    }
}
BoUserRegistrationConfirmationPayload *payload = ; // A backoffice user registration confirmation payload
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// confirm backoffice_registration
[apiInstance backofficeRegistrationConfirmWith:payload
    xForwardedFor:xForwardedFor
              completionHandler: ^(Bo_user output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.BackofficeRegistrationApi()

var payload = ; // {BoUserRegistrationConfirmationPayload} A backoffice user registration confirmation payload

var opts = { 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeRegistrationConfirm(payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeRegistrationConfirmExample
    {
        public void main()
        {
            
            var apiInstance = new BackofficeRegistrationApi();
            var payload = new BoUserRegistrationConfirmationPayload(); // BoUserRegistrationConfirmationPayload | A backoffice user registration confirmation payload
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // confirm backoffice_registration
                Bo_user result = apiInstance.backofficeRegistrationConfirm(payload, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeRegistrationApi.backofficeRegistrationConfirm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BackofficeRegistrationApi();
$payload = ; // BoUserRegistrationConfirmationPayload | A backoffice user registration confirmation payload
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->backofficeRegistrationConfirm($payload, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeRegistrationApi->backofficeRegistrationConfirm: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeRegistrationApi;

my $api_instance = WWW::SwaggerClient::BackofficeRegistrationApi->new();
my $payload = WWW::SwaggerClient::Object::BoUserRegistrationConfirmationPayload->new(); # BoUserRegistrationConfirmationPayload | A backoffice user registration confirmation payload
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->backofficeRegistrationConfirm(payload => $payload, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeRegistrationApi->backofficeRegistrationConfirm: $@\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.BackofficeRegistrationApi()
payload =  # BoUserRegistrationConfirmationPayload | A backoffice user registration confirmation payload
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # confirm backoffice_registration
    api_response = api_instance.backoffice_registration_confirm(payload, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeRegistrationApi->backofficeRegistrationConfirm: %s\n" % e)

Parameters

Header parameters
Name Description
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Name Type Format Description
Authorization String Generated JWT
Authorization-Token-Expires String Expiration of the authorization token

Status: 400 - Bad Request


backofficeRegistrationCreate

create backoffice_registration

Create new backoffice user registration


/0.0.1/backoffice/bouser_registrations

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/backoffice/bouser_registrations"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeRegistrationApi;

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

public class BackofficeRegistrationApiExample {

    public static void main(String[] args) {
        
        BackofficeRegistrationApi apiInstance = new BackofficeRegistrationApi();
        BoUserRegistrationPayload payload = ; // BoUserRegistrationPayload | A backoffice user registration payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            apiInstance.backofficeRegistrationCreate(payload, acceptLanguage, xForwardedFor);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeRegistrationApi#backofficeRegistrationCreate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeRegistrationApi;

public class BackofficeRegistrationApiExample {

    public static void main(String[] args) {
        BackofficeRegistrationApi apiInstance = new BackofficeRegistrationApi();
        BoUserRegistrationPayload payload = ; // BoUserRegistrationPayload | A backoffice user registration payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            apiInstance.backofficeRegistrationCreate(payload, acceptLanguage, xForwardedFor);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeRegistrationApi#backofficeRegistrationCreate");
            e.printStackTrace();
        }
    }
}
BoUserRegistrationPayload *payload = ; // A backoffice user registration payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// create backoffice_registration
[apiInstance backofficeRegistrationCreateWith:payload
    acceptLanguage:acceptLanguage
    xForwardedFor:xForwardedFor
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.BackofficeRegistrationApi()

var payload = ; // {BoUserRegistrationPayload} A backoffice user registration payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeRegistrationCreate(payload, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeRegistrationCreateExample
    {
        public void main()
        {
            
            var apiInstance = new BackofficeRegistrationApi();
            var payload = new BoUserRegistrationPayload(); // BoUserRegistrationPayload | A backoffice user registration payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // create backoffice_registration
                apiInstance.backofficeRegistrationCreate(payload, acceptLanguage, xForwardedFor);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeRegistrationApi.backofficeRegistrationCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BackofficeRegistrationApi();
$payload = ; // BoUserRegistrationPayload | A backoffice user registration payload
$acceptLanguage = acceptLanguage_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $api_instance->backofficeRegistrationCreate($payload, $acceptLanguage, $xForwardedFor);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeRegistrationApi->backofficeRegistrationCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeRegistrationApi;

my $api_instance = WWW::SwaggerClient::BackofficeRegistrationApi->new();
my $payload = WWW::SwaggerClient::Object::BoUserRegistrationPayload->new(); # BoUserRegistrationPayload | A backoffice user registration payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    $api_instance->backofficeRegistrationCreate(payload => $payload, acceptLanguage => $acceptLanguage, xForwardedFor => $xForwardedFor);
};
if ($@) {
    warn "Exception when calling BackofficeRegistrationApi->backofficeRegistrationCreate: $@\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.BackofficeRegistrationApi()
payload =  # BoUserRegistrationPayload | A backoffice user registration payload
acceptLanguage = acceptLanguage_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # create backoffice_registration
    api_instance.backoffice_registration_create(payload, acceptLanguage=acceptLanguage, xForwardedFor=xForwardedFor)
except ApiException as e:
    print("Exception when calling BackofficeRegistrationApi->backofficeRegistrationCreate: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 201 - Resource created

Name Type Format Description
Location String href to created resource

Status: 400 - Bad Request


backofficeRegistrationDelete

delete backoffice_registration


/0.0.1/backoffice/bouser_registrations/{id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bouser_registrations/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeRegistrationApi;

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

public class BackofficeRegistrationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeRegistrationApi apiInstance = new BackofficeRegistrationApi();
        String id = id_example; // String | Backoffice user registration ID
        try {
            apiInstance.backofficeRegistrationDelete(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeRegistrationApi#backofficeRegistrationDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeRegistrationApi;

public class BackofficeRegistrationApiExample {

    public static void main(String[] args) {
        BackofficeRegistrationApi apiInstance = new BackofficeRegistrationApi();
        String id = id_example; // String | Backoffice user registration ID
        try {
            apiInstance.backofficeRegistrationDelete(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeRegistrationApi#backofficeRegistrationDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Backoffice user registration ID

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

// delete backoffice_registration
[apiInstance backofficeRegistrationDeleteWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeRegistrationApi()

var id = id_example; // {String} Backoffice user registration ID

api.backofficeRegistrationDelete(id).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeRegistrationDeleteExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeRegistrationApi();
            var id = id_example;  // String | Backoffice user registration ID

            try
            {
                // delete backoffice_registration
                apiInstance.backofficeRegistrationDelete(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeRegistrationApi.backofficeRegistrationDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeRegistrationApi();
$id = id_example; // String | Backoffice user registration ID

try {
    $api_instance->backofficeRegistrationDelete($id);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeRegistrationApi->backofficeRegistrationDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeRegistrationApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeRegistrationApi->new();
my $id = id_example; # String | Backoffice user registration ID

eval { 
    $api_instance->backofficeRegistrationDelete(id => $id);
};
if ($@) {
    warn "Exception when calling BackofficeRegistrationApi->backofficeRegistrationDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeRegistrationApi()
id = id_example # String | Backoffice user registration ID

try: 
    # delete backoffice_registration
    api_instance.backoffice_registration_delete(id)
except ApiException as e:
    print("Exception when calling BackofficeRegistrationApi->backofficeRegistrationDelete: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Backoffice user registration ID
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 404 - Not Found


backofficeRegistrationList

list backoffice_registration

Retrieve all backoffice registrations.


/0.0.1/backoffice/bouser_registrations/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bouser_registrations/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeRegistrationApi;

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

public class BackofficeRegistrationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeRegistrationApi apiInstance = new BackofficeRegistrationApi();
        try {
            Bo_user_registrationCollection result = apiInstance.backofficeRegistrationList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeRegistrationApi#backofficeRegistrationList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeRegistrationApi;

public class BackofficeRegistrationApiExample {

    public static void main(String[] args) {
        BackofficeRegistrationApi apiInstance = new BackofficeRegistrationApi();
        try {
            Bo_user_registrationCollection result = apiInstance.backofficeRegistrationList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeRegistrationApi#backofficeRegistrationList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


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

// list backoffice_registration
[apiInstance backofficeRegistrationListWithCompletionHandler: 
              ^(Bo_user_registrationCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeRegistrationApi()
api.backofficeRegistrationList().then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeRegistrationListExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeRegistrationApi();

            try
            {
                // list backoffice_registration
                Bo_user_registrationCollection result = apiInstance.backofficeRegistrationList();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeRegistrationApi.backofficeRegistrationList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeRegistrationApi();

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

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

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

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

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

try: 
    # list backoffice_registration
    api_response = api_instance.backoffice_registration_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeRegistrationApi->backofficeRegistrationList: %s\n" % e)

Parameters

Responses

Status: 200 - OK


backofficeRegistrationShow

show backoffice_registration

Retrieve backoffice user registration with given id.


/0.0.1/backoffice/bouser_registrations/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/bouser_registrations/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeRegistrationApi;

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

public class BackofficeRegistrationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeRegistrationApi apiInstance = new BackofficeRegistrationApi();
        String id = id_example; // String | Backoffice user registration ID
        try {
            Bo_user_registration result = apiInstance.backofficeRegistrationShow(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeRegistrationApi#backofficeRegistrationShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeRegistrationApi;

public class BackofficeRegistrationApiExample {

    public static void main(String[] args) {
        BackofficeRegistrationApi apiInstance = new BackofficeRegistrationApi();
        String id = id_example; // String | Backoffice user registration ID
        try {
            Bo_user_registration result = apiInstance.backofficeRegistrationShow(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeRegistrationApi#backofficeRegistrationShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Backoffice user registration ID

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

// show backoffice_registration
[apiInstance backofficeRegistrationShowWith:id
              completionHandler: ^(Bo_user_registration output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeRegistrationApi()

var id = id_example; // {String} Backoffice user registration ID

api.backofficeRegistrationShow(id).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeRegistrationShowExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeRegistrationApi();
            var id = id_example;  // String | Backoffice user registration ID

            try
            {
                // show backoffice_registration
                Bo_user_registration result = apiInstance.backofficeRegistrationShow(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeRegistrationApi.backofficeRegistrationShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeRegistrationApi();
$id = id_example; // String | Backoffice user registration ID

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

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeRegistrationApi->new();
my $id = id_example; # String | Backoffice user registration ID

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeRegistrationApi()
id = id_example # String | Backoffice user registration ID

try: 
    # show backoffice_registration
    api_response = api_instance.backoffice_registration_show(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeRegistrationApi->backofficeRegistrationShow: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Backoffice user registration ID
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 404 - Not Found


BackofficeSubscriptionBill

backofficeSubscriptionBillShow

show backoffice_subscription_bill

Retrieve a subscription bill.


/0.0.1/backoffice/subscription_bill

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/backoffice/subscription_bill"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeSubscriptionBillApi;

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

public class BackofficeSubscriptionBillApiExample {

    public static void main(String[] args) {
        
        BackofficeSubscriptionBillApi apiInstance = new BackofficeSubscriptionBillApi();
        SubscriptionBillPayload payload = ; // SubscriptionBillPayload | Subscription bill payload
        String organisation = organisation_example; // String | 
        try {
            Subscription_bill result = apiInstance.backofficeSubscriptionBillShow(payload, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionBillApi#backofficeSubscriptionBillShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeSubscriptionBillApi;

public class BackofficeSubscriptionBillApiExample {

    public static void main(String[] args) {
        BackofficeSubscriptionBillApi apiInstance = new BackofficeSubscriptionBillApi();
        SubscriptionBillPayload payload = ; // SubscriptionBillPayload | Subscription bill payload
        String organisation = organisation_example; // String | 
        try {
            Subscription_bill result = apiInstance.backofficeSubscriptionBillShow(payload, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionBillApi#backofficeSubscriptionBillShow");
            e.printStackTrace();
        }
    }
}
SubscriptionBillPayload *payload = ; // Subscription bill payload
String *organisation = organisation_example; //  (optional)

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

// show backoffice_subscription_bill
[apiInstance backofficeSubscriptionBillShowWith:payload
    organisation:organisation
              completionHandler: ^(Subscription_bill output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.BackofficeSubscriptionBillApi()

var payload = ; // {SubscriptionBillPayload} Subscription bill payload

var opts = { 
  'organisation': organisation_example // {String} 
};
api.backofficeSubscriptionBillShow(payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeSubscriptionBillShowExample
    {
        public void main()
        {
            
            var apiInstance = new BackofficeSubscriptionBillApi();
            var payload = new SubscriptionBillPayload(); // SubscriptionBillPayload | Subscription bill payload
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // show backoffice_subscription_bill
                Subscription_bill result = apiInstance.backofficeSubscriptionBillShow(payload, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeSubscriptionBillApi.backofficeSubscriptionBillShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BackofficeSubscriptionBillApi();
$payload = ; // SubscriptionBillPayload | Subscription bill payload
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeSubscriptionBillShow($payload, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeSubscriptionBillApi->backofficeSubscriptionBillShow: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeSubscriptionBillApi;

my $api_instance = WWW::SwaggerClient::BackofficeSubscriptionBillApi->new();
my $payload = WWW::SwaggerClient::Object::SubscriptionBillPayload->new(); # SubscriptionBillPayload | Subscription bill payload
my $organisation = organisation_example; # String | 

eval { 
    my $result = $api_instance->backofficeSubscriptionBillShow(payload => $payload, organisation => $organisation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeSubscriptionBillApi->backofficeSubscriptionBillShow: $@\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.BackofficeSubscriptionBillApi()
payload =  # SubscriptionBillPayload | Subscription bill payload
organisation = organisation_example # String |  (optional)

try: 
    # show backoffice_subscription_bill
    api_response = api_instance.backoffice_subscription_bill_show(payload, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeSubscriptionBillApi->backofficeSubscriptionBillShow: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request


BackofficeSubscriptionInvoice

backofficeSubscriptionInvoiceCreatePayment

create_payment backoffice_subscription_invoice

Create new payment


/0.0.1/backoffice/subscription_invoices/{id}/payments

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/subscription_invoices/{id}/payments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeSubscriptionInvoiceApi;

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

public class BackofficeSubscriptionInvoiceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeSubscriptionInvoiceApi apiInstance = new BackofficeSubscriptionInvoiceApi();
        String id = id_example; // String | Subscription invoice ID
        PaymentCreatePayload payload = ; // PaymentCreatePayload | Payment create payload
        String organisation = organisation_example; // String | 
        try {
            Payment result = apiInstance.backofficeSubscriptionInvoiceCreatePayment(id, payload, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionInvoiceApi#backofficeSubscriptionInvoiceCreatePayment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeSubscriptionInvoiceApi;

public class BackofficeSubscriptionInvoiceApiExample {

    public static void main(String[] args) {
        BackofficeSubscriptionInvoiceApi apiInstance = new BackofficeSubscriptionInvoiceApi();
        String id = id_example; // String | Subscription invoice ID
        PaymentCreatePayload payload = ; // PaymentCreatePayload | Payment create payload
        String organisation = organisation_example; // String | 
        try {
            Payment result = apiInstance.backofficeSubscriptionInvoiceCreatePayment(id, payload, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionInvoiceApi#backofficeSubscriptionInvoiceCreatePayment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Subscription invoice ID
PaymentCreatePayload *payload = ; // Payment create payload
String *organisation = organisation_example; //  (optional)

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

// create_payment backoffice_subscription_invoice
[apiInstance backofficeSubscriptionInvoiceCreatePaymentWith:id
    payload:payload
    organisation:organisation
              completionHandler: ^(Payment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeSubscriptionInvoiceApi()

var id = id_example; // {String} Subscription invoice ID

var payload = ; // {PaymentCreatePayload} Payment create payload

var opts = { 
  'organisation': organisation_example // {String} 
};
api.backofficeSubscriptionInvoiceCreatePayment(id, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeSubscriptionInvoiceCreatePaymentExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeSubscriptionInvoiceApi();
            var id = id_example;  // String | Subscription invoice ID
            var payload = new PaymentCreatePayload(); // PaymentCreatePayload | Payment create payload
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // create_payment backoffice_subscription_invoice
                Payment result = apiInstance.backofficeSubscriptionInvoiceCreatePayment(id, payload, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeSubscriptionInvoiceApi.backofficeSubscriptionInvoiceCreatePayment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeSubscriptionInvoiceApi();
$id = id_example; // String | Subscription invoice ID
$payload = ; // PaymentCreatePayload | Payment create payload
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeSubscriptionInvoiceCreatePayment($id, $payload, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeSubscriptionInvoiceApi->backofficeSubscriptionInvoiceCreatePayment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeSubscriptionInvoiceApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeSubscriptionInvoiceApi->new();
my $id = id_example; # String | Subscription invoice ID
my $payload = WWW::SwaggerClient::Object::PaymentCreatePayload->new(); # PaymentCreatePayload | Payment create payload
my $organisation = organisation_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeSubscriptionInvoiceApi()
id = id_example # String | Subscription invoice ID
payload =  # PaymentCreatePayload | Payment create payload
organisation = organisation_example # String |  (optional)

try: 
    # create_payment backoffice_subscription_invoice
    api_response = api_instance.backoffice_subscription_invoice_create_payment(id, payload, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeSubscriptionInvoiceApi->backofficeSubscriptionInvoiceCreatePayment: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Subscription invoice ID
Required
Header parameters
Name Description
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeSubscriptionInvoiceCreatePayments

create_payments backoffice_subscription_invoice

Create payments for existing invoices.


/0.0.1/backoffice/subscription_invoices/create_payments

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/subscription_invoices/create_payments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeSubscriptionInvoiceApi;

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

public class BackofficeSubscriptionInvoiceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeSubscriptionInvoiceApi apiInstance = new BackofficeSubscriptionInvoiceApi();
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeSubscriptionInvoiceCreatePayments(organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionInvoiceApi#backofficeSubscriptionInvoiceCreatePayments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeSubscriptionInvoiceApi;

public class BackofficeSubscriptionInvoiceApiExample {

    public static void main(String[] args) {
        BackofficeSubscriptionInvoiceApi apiInstance = new BackofficeSubscriptionInvoiceApi();
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeSubscriptionInvoiceCreatePayments(organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionInvoiceApi#backofficeSubscriptionInvoiceCreatePayments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; //  (optional)

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

// create_payments backoffice_subscription_invoice
[apiInstance backofficeSubscriptionInvoiceCreatePaymentsWith:organisation
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeSubscriptionInvoiceApi()

var opts = { 
  'organisation': organisation_example // {String} 
};
api.backofficeSubscriptionInvoiceCreatePayments(opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeSubscriptionInvoiceCreatePaymentsExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeSubscriptionInvoiceApi();
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // create_payments backoffice_subscription_invoice
                apiInstance.backofficeSubscriptionInvoiceCreatePayments(organisation);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeSubscriptionInvoiceApi.backofficeSubscriptionInvoiceCreatePayments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeSubscriptionInvoiceApi();
$organisation = organisation_example; // String | 

try {
    $api_instance->backofficeSubscriptionInvoiceCreatePayments($organisation);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeSubscriptionInvoiceApi->backofficeSubscriptionInvoiceCreatePayments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeSubscriptionInvoiceApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeSubscriptionInvoiceApi->new();
my $organisation = organisation_example; # String | 

eval { 
    $api_instance->backofficeSubscriptionInvoiceCreatePayments(organisation => $organisation);
};
if ($@) {
    warn "Exception when calling BackofficeSubscriptionInvoiceApi->backofficeSubscriptionInvoiceCreatePayments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeSubscriptionInvoiceApi()
organisation = organisation_example # String |  (optional)

try: 
    # create_payments backoffice_subscription_invoice
    api_instance.backoffice_subscription_invoice_create_payments(organisation=organisation)
except ApiException as e:
    print("Exception when calling BackofficeSubscriptionInvoiceApi->backofficeSubscriptionInvoiceCreatePayments: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation
String

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeSubscriptionInvoiceDelete

delete backoffice_subscription_invoice


/0.0.1/backoffice/subscription_invoices/{id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/subscription_invoices/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeSubscriptionInvoiceApi;

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

public class BackofficeSubscriptionInvoiceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeSubscriptionInvoiceApi apiInstance = new BackofficeSubscriptionInvoiceApi();
        String id = id_example; // String | Invoice ID
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeSubscriptionInvoiceDelete(id, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionInvoiceApi#backofficeSubscriptionInvoiceDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeSubscriptionInvoiceApi;

public class BackofficeSubscriptionInvoiceApiExample {

    public static void main(String[] args) {
        BackofficeSubscriptionInvoiceApi apiInstance = new BackofficeSubscriptionInvoiceApi();
        String id = id_example; // String | Invoice ID
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeSubscriptionInvoiceDelete(id, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionInvoiceApi#backofficeSubscriptionInvoiceDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Invoice ID
String *organisation = organisation_example; //  (optional)

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

// delete backoffice_subscription_invoice
[apiInstance backofficeSubscriptionInvoiceDeleteWith:id
    organisation:organisation
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeSubscriptionInvoiceApi()

var id = id_example; // {String} Invoice ID

var opts = { 
  'organisation': organisation_example // {String} 
};
api.backofficeSubscriptionInvoiceDelete(id, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeSubscriptionInvoiceDeleteExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeSubscriptionInvoiceApi();
            var id = id_example;  // String | Invoice ID
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // delete backoffice_subscription_invoice
                apiInstance.backofficeSubscriptionInvoiceDelete(id, organisation);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeSubscriptionInvoiceApi.backofficeSubscriptionInvoiceDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeSubscriptionInvoiceApi();
$id = id_example; // String | Invoice ID
$organisation = organisation_example; // String | 

try {
    $api_instance->backofficeSubscriptionInvoiceDelete($id, $organisation);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeSubscriptionInvoiceApi->backofficeSubscriptionInvoiceDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeSubscriptionInvoiceApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeSubscriptionInvoiceApi->new();
my $id = id_example; # String | Invoice ID
my $organisation = organisation_example; # String | 

eval { 
    $api_instance->backofficeSubscriptionInvoiceDelete(id => $id, organisation => $organisation);
};
if ($@) {
    warn "Exception when calling BackofficeSubscriptionInvoiceApi->backofficeSubscriptionInvoiceDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeSubscriptionInvoiceApi()
id = id_example # String | Invoice ID
organisation = organisation_example # String |  (optional)

try: 
    # delete backoffice_subscription_invoice
    api_instance.backoffice_subscription_invoice_delete(id, organisation=organisation)
except ApiException as e:
    print("Exception when calling BackofficeSubscriptionInvoiceApi->backofficeSubscriptionInvoiceDelete: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Invoice ID
Required
Header parameters
Name Description
Organisation
String

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 404 - Not Found


backofficeSubscriptionInvoiceDownload

download backoffice_subscription_invoice

Retrieve subscription invoice with given id.


/0.0.1/backoffice/subscription_invoices/{id}/download/{format}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/subscription_invoices/{id}/download/{format}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeSubscriptionInvoiceApi;

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

public class BackofficeSubscriptionInvoiceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeSubscriptionInvoiceApi apiInstance = new BackofficeSubscriptionInvoiceApi();
        String format = format_example; // String | Format
        String id = id_example; // String | Subscription invoice ID
        String organisation = organisation_example; // String | 
        try {
            Download result = apiInstance.backofficeSubscriptionInvoiceDownload(format, id, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionInvoiceApi#backofficeSubscriptionInvoiceDownload");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeSubscriptionInvoiceApi;

public class BackofficeSubscriptionInvoiceApiExample {

    public static void main(String[] args) {
        BackofficeSubscriptionInvoiceApi apiInstance = new BackofficeSubscriptionInvoiceApi();
        String format = format_example; // String | Format
        String id = id_example; // String | Subscription invoice ID
        String organisation = organisation_example; // String | 
        try {
            Download result = apiInstance.backofficeSubscriptionInvoiceDownload(format, id, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionInvoiceApi#backofficeSubscriptionInvoiceDownload");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *format = format_example; // Format
String *id = id_example; // Subscription invoice ID
String *organisation = organisation_example; //  (optional)

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

// download backoffice_subscription_invoice
[apiInstance backofficeSubscriptionInvoiceDownloadWith:format
    id:id
    organisation:organisation
              completionHandler: ^(Download output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeSubscriptionInvoiceApi()

var format = format_example; // {String} Format

var id = id_example; // {String} Subscription invoice ID

var opts = { 
  'organisation': organisation_example // {String} 
};
api.backofficeSubscriptionInvoiceDownload(format, id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeSubscriptionInvoiceDownloadExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeSubscriptionInvoiceApi();
            var format = format_example;  // String | Format
            var id = id_example;  // String | Subscription invoice ID
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // download backoffice_subscription_invoice
                Download result = apiInstance.backofficeSubscriptionInvoiceDownload(format, id, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeSubscriptionInvoiceApi.backofficeSubscriptionInvoiceDownload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeSubscriptionInvoiceApi();
$format = format_example; // String | Format
$id = id_example; // String | Subscription invoice ID
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeSubscriptionInvoiceDownload($format, $id, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeSubscriptionInvoiceApi->backofficeSubscriptionInvoiceDownload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeSubscriptionInvoiceApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeSubscriptionInvoiceApi->new();
my $format = format_example; # String | Format
my $id = id_example; # String | Subscription invoice ID
my $organisation = organisation_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeSubscriptionInvoiceApi()
format = format_example # String | Format
id = id_example # String | Subscription invoice ID
organisation = organisation_example # String |  (optional)

try: 
    # download backoffice_subscription_invoice
    api_response = api_instance.backoffice_subscription_invoice_download(format, id, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeSubscriptionInvoiceApi->backofficeSubscriptionInvoiceDownload: %s\n" % e)

Parameters

Path parameters
Name Description
format*
String
Format
Required
id*
String
Subscription invoice ID
Required
Header parameters
Name Description
Organisation
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeSubscriptionInvoiceDownloadList

download_list backoffice_subscription_invoice

Download all invoices in PDF format.


/0.0.1/backoffice/subscription_invoices/list/download

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/subscription_invoices/list/download"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeSubscriptionInvoiceApi;

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

public class BackofficeSubscriptionInvoiceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeSubscriptionInvoiceApi apiInstance = new BackofficeSubscriptionInvoiceApi();
        SubscriptionInvoiceUpdateCollectionPayload payload = ; // SubscriptionInvoiceUpdateCollectionPayload | A backoffice subscription invoice update collection payload
        String organisation = organisation_example; // String | 
        try {
            Download result = apiInstance.backofficeSubscriptionInvoiceDownloadList(payload, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionInvoiceApi#backofficeSubscriptionInvoiceDownloadList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeSubscriptionInvoiceApi;

public class BackofficeSubscriptionInvoiceApiExample {

    public static void main(String[] args) {
        BackofficeSubscriptionInvoiceApi apiInstance = new BackofficeSubscriptionInvoiceApi();
        SubscriptionInvoiceUpdateCollectionPayload payload = ; // SubscriptionInvoiceUpdateCollectionPayload | A backoffice subscription invoice update collection payload
        String organisation = organisation_example; // String | 
        try {
            Download result = apiInstance.backofficeSubscriptionInvoiceDownloadList(payload, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionInvoiceApi#backofficeSubscriptionInvoiceDownloadList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

SubscriptionInvoiceUpdateCollectionPayload *payload = ; // A backoffice subscription invoice update collection payload
String *organisation = organisation_example; //  (optional)

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

// download_list backoffice_subscription_invoice
[apiInstance backofficeSubscriptionInvoiceDownloadListWith:payload
    organisation:organisation
              completionHandler: ^(Download output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeSubscriptionInvoiceApi()

var payload = ; // {SubscriptionInvoiceUpdateCollectionPayload} A backoffice subscription invoice update collection payload

var opts = { 
  'organisation': organisation_example // {String} 
};
api.backofficeSubscriptionInvoiceDownloadList(payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeSubscriptionInvoiceDownloadListExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeSubscriptionInvoiceApi();
            var payload = new SubscriptionInvoiceUpdateCollectionPayload(); // SubscriptionInvoiceUpdateCollectionPayload | A backoffice subscription invoice update collection payload
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // download_list backoffice_subscription_invoice
                Download result = apiInstance.backofficeSubscriptionInvoiceDownloadList(payload, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeSubscriptionInvoiceApi.backofficeSubscriptionInvoiceDownloadList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeSubscriptionInvoiceApi();
$payload = ; // SubscriptionInvoiceUpdateCollectionPayload | A backoffice subscription invoice update collection payload
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeSubscriptionInvoiceDownloadList($payload, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeSubscriptionInvoiceApi->backofficeSubscriptionInvoiceDownloadList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeSubscriptionInvoiceApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeSubscriptionInvoiceApi->new();
my $payload = WWW::SwaggerClient::Object::SubscriptionInvoiceUpdateCollectionPayload->new(); # SubscriptionInvoiceUpdateCollectionPayload | A backoffice subscription invoice update collection payload
my $organisation = organisation_example; # String | 

eval { 
    my $result = $api_instance->backofficeSubscriptionInvoiceDownloadList(payload => $payload, organisation => $organisation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeSubscriptionInvoiceApi->backofficeSubscriptionInvoiceDownloadList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeSubscriptionInvoiceApi()
payload =  # SubscriptionInvoiceUpdateCollectionPayload | A backoffice subscription invoice update collection payload
organisation = organisation_example # String |  (optional)

try: 
    # download_list backoffice_subscription_invoice
    api_response = api_instance.backoffice_subscription_invoice_download_list(payload, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeSubscriptionInvoiceApi->backofficeSubscriptionInvoiceDownloadList: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeSubscriptionInvoiceGenerate

generate backoffice_subscription_invoice

Generate outstanding invoices.


/0.0.1/backoffice/subscription_invoices/generate

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/subscription_invoices/generate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeSubscriptionInvoiceApi;

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

public class BackofficeSubscriptionInvoiceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeSubscriptionInvoiceApi apiInstance = new BackofficeSubscriptionInvoiceApi();
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeSubscriptionInvoiceGenerate(organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionInvoiceApi#backofficeSubscriptionInvoiceGenerate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeSubscriptionInvoiceApi;

public class BackofficeSubscriptionInvoiceApiExample {

    public static void main(String[] args) {
        BackofficeSubscriptionInvoiceApi apiInstance = new BackofficeSubscriptionInvoiceApi();
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeSubscriptionInvoiceGenerate(organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionInvoiceApi#backofficeSubscriptionInvoiceGenerate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; //  (optional)

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

// generate backoffice_subscription_invoice
[apiInstance backofficeSubscriptionInvoiceGenerateWith:organisation
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeSubscriptionInvoiceApi()

var opts = { 
  'organisation': organisation_example // {String} 
};
api.backofficeSubscriptionInvoiceGenerate(opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeSubscriptionInvoiceGenerateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeSubscriptionInvoiceApi();
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // generate backoffice_subscription_invoice
                apiInstance.backofficeSubscriptionInvoiceGenerate(organisation);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeSubscriptionInvoiceApi.backofficeSubscriptionInvoiceGenerate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeSubscriptionInvoiceApi();
$organisation = organisation_example; // String | 

try {
    $api_instance->backofficeSubscriptionInvoiceGenerate($organisation);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeSubscriptionInvoiceApi->backofficeSubscriptionInvoiceGenerate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeSubscriptionInvoiceApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeSubscriptionInvoiceApi->new();
my $organisation = organisation_example; # String | 

eval { 
    $api_instance->backofficeSubscriptionInvoiceGenerate(organisation => $organisation);
};
if ($@) {
    warn "Exception when calling BackofficeSubscriptionInvoiceApi->backofficeSubscriptionInvoiceGenerate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeSubscriptionInvoiceApi()
organisation = organisation_example # String |  (optional)

try: 
    # generate backoffice_subscription_invoice
    api_instance.backoffice_subscription_invoice_generate(organisation=organisation)
except ApiException as e:
    print("Exception when calling BackofficeSubscriptionInvoiceApi->backofficeSubscriptionInvoiceGenerate: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation
String

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeSubscriptionInvoiceList

list backoffice_subscription_invoice

Retrieve all invoices.


/0.0.1/backoffice/subscription_invoices/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/subscription_invoices/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeSubscriptionInvoiceApi;

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

public class BackofficeSubscriptionInvoiceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeSubscriptionInvoiceApi apiInstance = new BackofficeSubscriptionInvoiceApi();
        SubscriptionInvoiceCollectionPayload payload = ; // SubscriptionInvoiceCollectionPayload | A backoffice subscription invoice collection payload
        String organisation = organisation_example; // String | 
        try {
            Subscription_invoice_collection result = apiInstance.backofficeSubscriptionInvoiceList(payload, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionInvoiceApi#backofficeSubscriptionInvoiceList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeSubscriptionInvoiceApi;

public class BackofficeSubscriptionInvoiceApiExample {

    public static void main(String[] args) {
        BackofficeSubscriptionInvoiceApi apiInstance = new BackofficeSubscriptionInvoiceApi();
        SubscriptionInvoiceCollectionPayload payload = ; // SubscriptionInvoiceCollectionPayload | A backoffice subscription invoice collection payload
        String organisation = organisation_example; // String | 
        try {
            Subscription_invoice_collection result = apiInstance.backofficeSubscriptionInvoiceList(payload, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionInvoiceApi#backofficeSubscriptionInvoiceList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

SubscriptionInvoiceCollectionPayload *payload = ; // A backoffice subscription invoice collection payload
String *organisation = organisation_example; //  (optional)

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

// list backoffice_subscription_invoice
[apiInstance backofficeSubscriptionInvoiceListWith:payload
    organisation:organisation
              completionHandler: ^(Subscription_invoice_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeSubscriptionInvoiceApi()

var payload = ; // {SubscriptionInvoiceCollectionPayload} A backoffice subscription invoice collection payload

var opts = { 
  'organisation': organisation_example // {String} 
};
api.backofficeSubscriptionInvoiceList(payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeSubscriptionInvoiceListExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeSubscriptionInvoiceApi();
            var payload = new SubscriptionInvoiceCollectionPayload(); // SubscriptionInvoiceCollectionPayload | A backoffice subscription invoice collection payload
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // list backoffice_subscription_invoice
                Subscription_invoice_collection result = apiInstance.backofficeSubscriptionInvoiceList(payload, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeSubscriptionInvoiceApi.backofficeSubscriptionInvoiceList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeSubscriptionInvoiceApi();
$payload = ; // SubscriptionInvoiceCollectionPayload | A backoffice subscription invoice collection payload
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeSubscriptionInvoiceList($payload, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeSubscriptionInvoiceApi->backofficeSubscriptionInvoiceList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeSubscriptionInvoiceApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeSubscriptionInvoiceApi->new();
my $payload = WWW::SwaggerClient::Object::SubscriptionInvoiceCollectionPayload->new(); # SubscriptionInvoiceCollectionPayload | A backoffice subscription invoice collection payload
my $organisation = organisation_example; # String | 

eval { 
    my $result = $api_instance->backofficeSubscriptionInvoiceList(payload => $payload, organisation => $organisation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeSubscriptionInvoiceApi->backofficeSubscriptionInvoiceList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeSubscriptionInvoiceApi()
payload =  # SubscriptionInvoiceCollectionPayload | A backoffice subscription invoice collection payload
organisation = organisation_example # String |  (optional)

try: 
    # list backoffice_subscription_invoice
    api_response = api_instance.backoffice_subscription_invoice_list(payload, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeSubscriptionInvoiceApi->backofficeSubscriptionInvoiceList: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeSubscriptionInvoiceRerender

rerender backoffice_subscription_invoice

Rerender existing invoice(s).


/0.0.1/backoffice/subscription_invoices/rerender

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/subscription_invoices/rerender"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeSubscriptionInvoiceApi;

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

public class BackofficeSubscriptionInvoiceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeSubscriptionInvoiceApi apiInstance = new BackofficeSubscriptionInvoiceApi();
        SubscriptionInvoiceRerenderPayload payload = ; // SubscriptionInvoiceRerenderPayload | Subscription invoice rerender payload
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeSubscriptionInvoiceRerender(payload, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionInvoiceApi#backofficeSubscriptionInvoiceRerender");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeSubscriptionInvoiceApi;

public class BackofficeSubscriptionInvoiceApiExample {

    public static void main(String[] args) {
        BackofficeSubscriptionInvoiceApi apiInstance = new BackofficeSubscriptionInvoiceApi();
        SubscriptionInvoiceRerenderPayload payload = ; // SubscriptionInvoiceRerenderPayload | Subscription invoice rerender payload
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeSubscriptionInvoiceRerender(payload, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionInvoiceApi#backofficeSubscriptionInvoiceRerender");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

SubscriptionInvoiceRerenderPayload *payload = ; // Subscription invoice rerender payload
String *organisation = organisation_example; //  (optional)

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

// rerender backoffice_subscription_invoice
[apiInstance backofficeSubscriptionInvoiceRerenderWith:payload
    organisation:organisation
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeSubscriptionInvoiceApi()

var payload = ; // {SubscriptionInvoiceRerenderPayload} Subscription invoice rerender payload

var opts = { 
  'organisation': organisation_example // {String} 
};
api.backofficeSubscriptionInvoiceRerender(payload, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeSubscriptionInvoiceRerenderExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeSubscriptionInvoiceApi();
            var payload = new SubscriptionInvoiceRerenderPayload(); // SubscriptionInvoiceRerenderPayload | Subscription invoice rerender payload
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // rerender backoffice_subscription_invoice
                apiInstance.backofficeSubscriptionInvoiceRerender(payload, organisation);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeSubscriptionInvoiceApi.backofficeSubscriptionInvoiceRerender: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeSubscriptionInvoiceApi();
$payload = ; // SubscriptionInvoiceRerenderPayload | Subscription invoice rerender payload
$organisation = organisation_example; // String | 

try {
    $api_instance->backofficeSubscriptionInvoiceRerender($payload, $organisation);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeSubscriptionInvoiceApi->backofficeSubscriptionInvoiceRerender: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeSubscriptionInvoiceApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeSubscriptionInvoiceApi->new();
my $payload = WWW::SwaggerClient::Object::SubscriptionInvoiceRerenderPayload->new(); # SubscriptionInvoiceRerenderPayload | Subscription invoice rerender payload
my $organisation = organisation_example; # String | 

eval { 
    $api_instance->backofficeSubscriptionInvoiceRerender(payload => $payload, organisation => $organisation);
};
if ($@) {
    warn "Exception when calling BackofficeSubscriptionInvoiceApi->backofficeSubscriptionInvoiceRerender: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeSubscriptionInvoiceApi()
payload =  # SubscriptionInvoiceRerenderPayload | Subscription invoice rerender payload
organisation = organisation_example # String |  (optional)

try: 
    # rerender backoffice_subscription_invoice
    api_instance.backoffice_subscription_invoice_rerender(payload, organisation=organisation)
except ApiException as e:
    print("Exception when calling BackofficeSubscriptionInvoiceApi->backofficeSubscriptionInvoiceRerender: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeSubscriptionInvoiceRetryPayments

retry_payments backoffice_subscription_invoice

Retry payments for invoices with failed payments.


/0.0.1/backoffice/subscription_invoices/retry_payments

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/subscription_invoices/retry_payments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeSubscriptionInvoiceApi;

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

public class BackofficeSubscriptionInvoiceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeSubscriptionInvoiceApi apiInstance = new BackofficeSubscriptionInvoiceApi();
        SubscriptionInvoiceRetryFailedPaymentsPayload payload = ; // SubscriptionInvoiceRetryFailedPaymentsPayload | Subscription invoice retry failed payments payload
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeSubscriptionInvoiceRetryPayments(payload, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionInvoiceApi#backofficeSubscriptionInvoiceRetryPayments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeSubscriptionInvoiceApi;

public class BackofficeSubscriptionInvoiceApiExample {

    public static void main(String[] args) {
        BackofficeSubscriptionInvoiceApi apiInstance = new BackofficeSubscriptionInvoiceApi();
        SubscriptionInvoiceRetryFailedPaymentsPayload payload = ; // SubscriptionInvoiceRetryFailedPaymentsPayload | Subscription invoice retry failed payments payload
        String organisation = organisation_example; // String | 
        try {
            apiInstance.backofficeSubscriptionInvoiceRetryPayments(payload, organisation);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionInvoiceApi#backofficeSubscriptionInvoiceRetryPayments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

SubscriptionInvoiceRetryFailedPaymentsPayload *payload = ; // Subscription invoice retry failed payments payload
String *organisation = organisation_example; //  (optional)

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

// retry_payments backoffice_subscription_invoice
[apiInstance backofficeSubscriptionInvoiceRetryPaymentsWith:payload
    organisation:organisation
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeSubscriptionInvoiceApi()

var payload = ; // {SubscriptionInvoiceRetryFailedPaymentsPayload} Subscription invoice retry failed payments payload

var opts = { 
  'organisation': organisation_example // {String} 
};
api.backofficeSubscriptionInvoiceRetryPayments(payload, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeSubscriptionInvoiceRetryPaymentsExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeSubscriptionInvoiceApi();
            var payload = new SubscriptionInvoiceRetryFailedPaymentsPayload(); // SubscriptionInvoiceRetryFailedPaymentsPayload | Subscription invoice retry failed payments payload
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // retry_payments backoffice_subscription_invoice
                apiInstance.backofficeSubscriptionInvoiceRetryPayments(payload, organisation);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeSubscriptionInvoiceApi.backofficeSubscriptionInvoiceRetryPayments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeSubscriptionInvoiceApi();
$payload = ; // SubscriptionInvoiceRetryFailedPaymentsPayload | Subscription invoice retry failed payments payload
$organisation = organisation_example; // String | 

try {
    $api_instance->backofficeSubscriptionInvoiceRetryPayments($payload, $organisation);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeSubscriptionInvoiceApi->backofficeSubscriptionInvoiceRetryPayments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeSubscriptionInvoiceApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeSubscriptionInvoiceApi->new();
my $payload = WWW::SwaggerClient::Object::SubscriptionInvoiceRetryFailedPaymentsPayload->new(); # SubscriptionInvoiceRetryFailedPaymentsPayload | Subscription invoice retry failed payments payload
my $organisation = organisation_example; # String | 

eval { 
    $api_instance->backofficeSubscriptionInvoiceRetryPayments(payload => $payload, organisation => $organisation);
};
if ($@) {
    warn "Exception when calling BackofficeSubscriptionInvoiceApi->backofficeSubscriptionInvoiceRetryPayments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeSubscriptionInvoiceApi()
payload =  # SubscriptionInvoiceRetryFailedPaymentsPayload | Subscription invoice retry failed payments payload
organisation = organisation_example # String |  (optional)

try: 
    # retry_payments backoffice_subscription_invoice
    api_instance.backoffice_subscription_invoice_retry_payments(payload, organisation=organisation)
except ApiException as e:
    print("Exception when calling BackofficeSubscriptionInvoiceApi->backofficeSubscriptionInvoiceRetryPayments: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeSubscriptionInvoiceShow

show backoffice_subscription_invoice

Retrieve subscription invoice with given id.


/0.0.1/backoffice/subscription_invoices/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/subscription_invoices/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeSubscriptionInvoiceApi;

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

public class BackofficeSubscriptionInvoiceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeSubscriptionInvoiceApi apiInstance = new BackofficeSubscriptionInvoiceApi();
        String id = id_example; // String | Subscription invoice ID
        String organisation = organisation_example; // String | 
        try {
            Subscription_invoice result = apiInstance.backofficeSubscriptionInvoiceShow(id, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionInvoiceApi#backofficeSubscriptionInvoiceShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeSubscriptionInvoiceApi;

public class BackofficeSubscriptionInvoiceApiExample {

    public static void main(String[] args) {
        BackofficeSubscriptionInvoiceApi apiInstance = new BackofficeSubscriptionInvoiceApi();
        String id = id_example; // String | Subscription invoice ID
        String organisation = organisation_example; // String | 
        try {
            Subscription_invoice result = apiInstance.backofficeSubscriptionInvoiceShow(id, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionInvoiceApi#backofficeSubscriptionInvoiceShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Subscription invoice ID
String *organisation = organisation_example; //  (optional)

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

// show backoffice_subscription_invoice
[apiInstance backofficeSubscriptionInvoiceShowWith:id
    organisation:organisation
              completionHandler: ^(Subscription_invoice output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeSubscriptionInvoiceApi()

var id = id_example; // {String} Subscription invoice ID

var opts = { 
  'organisation': organisation_example // {String} 
};
api.backofficeSubscriptionInvoiceShow(id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeSubscriptionInvoiceShowExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeSubscriptionInvoiceApi();
            var id = id_example;  // String | Subscription invoice ID
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // show backoffice_subscription_invoice
                Subscription_invoice result = apiInstance.backofficeSubscriptionInvoiceShow(id, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeSubscriptionInvoiceApi.backofficeSubscriptionInvoiceShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeSubscriptionInvoiceApi();
$id = id_example; // String | Subscription invoice ID
$organisation = organisation_example; // String | 

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

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeSubscriptionInvoiceApi->new();
my $id = id_example; # String | Subscription invoice ID
my $organisation = organisation_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeSubscriptionInvoiceApi()
id = id_example # String | Subscription invoice ID
organisation = organisation_example # String |  (optional)

try: 
    # show backoffice_subscription_invoice
    api_response = api_instance.backoffice_subscription_invoice_show(id, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeSubscriptionInvoiceApi->backofficeSubscriptionInvoiceShow: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Subscription invoice ID
Required
Header parameters
Name Description
Organisation
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeSubscriptionInvoiceUpdate

update backoffice_subscription_invoice

Change subscription invoice


/0.0.1/backoffice/subscription_invoices/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/subscription_invoices/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeSubscriptionInvoiceApi;

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

public class BackofficeSubscriptionInvoiceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeSubscriptionInvoiceApi apiInstance = new BackofficeSubscriptionInvoiceApi();
        String id = id_example; // String | Invoice ID
        SubscriptionInvoiceUpdatePayload payload = ; // SubscriptionInvoiceUpdatePayload | Subscription invoice update payload
        String organisation = organisation_example; // String | 
        try {
            Subscription_invoice result = apiInstance.backofficeSubscriptionInvoiceUpdate(id, payload, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionInvoiceApi#backofficeSubscriptionInvoiceUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeSubscriptionInvoiceApi;

public class BackofficeSubscriptionInvoiceApiExample {

    public static void main(String[] args) {
        BackofficeSubscriptionInvoiceApi apiInstance = new BackofficeSubscriptionInvoiceApi();
        String id = id_example; // String | Invoice ID
        SubscriptionInvoiceUpdatePayload payload = ; // SubscriptionInvoiceUpdatePayload | Subscription invoice update payload
        String organisation = organisation_example; // String | 
        try {
            Subscription_invoice result = apiInstance.backofficeSubscriptionInvoiceUpdate(id, payload, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionInvoiceApi#backofficeSubscriptionInvoiceUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Invoice ID
SubscriptionInvoiceUpdatePayload *payload = ; // Subscription invoice update payload
String *organisation = organisation_example; //  (optional)

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

// update backoffice_subscription_invoice
[apiInstance backofficeSubscriptionInvoiceUpdateWith:id
    payload:payload
    organisation:organisation
              completionHandler: ^(Subscription_invoice output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeSubscriptionInvoiceApi()

var id = id_example; // {String} Invoice ID

var payload = ; // {SubscriptionInvoiceUpdatePayload} Subscription invoice update payload

var opts = { 
  'organisation': organisation_example // {String} 
};
api.backofficeSubscriptionInvoiceUpdate(id, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeSubscriptionInvoiceUpdateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeSubscriptionInvoiceApi();
            var id = id_example;  // String | Invoice ID
            var payload = new SubscriptionInvoiceUpdatePayload(); // SubscriptionInvoiceUpdatePayload | Subscription invoice update payload
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // update backoffice_subscription_invoice
                Subscription_invoice result = apiInstance.backofficeSubscriptionInvoiceUpdate(id, payload, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeSubscriptionInvoiceApi.backofficeSubscriptionInvoiceUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeSubscriptionInvoiceApi();
$id = id_example; // String | Invoice ID
$payload = ; // SubscriptionInvoiceUpdatePayload | Subscription invoice update payload
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeSubscriptionInvoiceUpdate($id, $payload, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeSubscriptionInvoiceApi->backofficeSubscriptionInvoiceUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeSubscriptionInvoiceApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeSubscriptionInvoiceApi->new();
my $id = id_example; # String | Invoice ID
my $payload = WWW::SwaggerClient::Object::SubscriptionInvoiceUpdatePayload->new(); # SubscriptionInvoiceUpdatePayload | Subscription invoice update payload
my $organisation = organisation_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeSubscriptionInvoiceApi()
id = id_example # String | Invoice ID
payload =  # SubscriptionInvoiceUpdatePayload | Subscription invoice update payload
organisation = organisation_example # String |  (optional)

try: 
    # update backoffice_subscription_invoice
    api_response = api_instance.backoffice_subscription_invoice_update(id, payload, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeSubscriptionInvoiceApi->backofficeSubscriptionInvoiceUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Invoice ID
Required
Header parameters
Name Description
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


BackofficeSubscriptionInvoiceBill

backofficeSubscriptionInvoiceBillShow

show backoffice_subscription_invoice_bill

Retrieve a subscription invoice bill.


/0.0.1/backoffice/subscription_invoice_bill

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/subscription_invoice_bill"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeSubscriptionInvoiceBillApi;

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

public class BackofficeSubscriptionInvoiceBillApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeSubscriptionInvoiceBillApi apiInstance = new BackofficeSubscriptionInvoiceBillApi();
        SubscriptionInvoiceBillPayload payload = ; // SubscriptionInvoiceBillPayload | Subscription invoice bill payload
        try {
            Subscription_invoice_bill result = apiInstance.backofficeSubscriptionInvoiceBillShow(payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionInvoiceBillApi#backofficeSubscriptionInvoiceBillShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeSubscriptionInvoiceBillApi;

public class BackofficeSubscriptionInvoiceBillApiExample {

    public static void main(String[] args) {
        BackofficeSubscriptionInvoiceBillApi apiInstance = new BackofficeSubscriptionInvoiceBillApi();
        SubscriptionInvoiceBillPayload payload = ; // SubscriptionInvoiceBillPayload | Subscription invoice bill payload
        try {
            Subscription_invoice_bill result = apiInstance.backofficeSubscriptionInvoiceBillShow(payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionInvoiceBillApi#backofficeSubscriptionInvoiceBillShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

SubscriptionInvoiceBillPayload *payload = ; // Subscription invoice bill payload

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

// show backoffice_subscription_invoice_bill
[apiInstance backofficeSubscriptionInvoiceBillShowWith:payload
              completionHandler: ^(Subscription_invoice_bill output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeSubscriptionInvoiceBillApi()

var payload = ; // {SubscriptionInvoiceBillPayload} Subscription invoice bill payload

api.backofficeSubscriptionInvoiceBillShow(payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeSubscriptionInvoiceBillShowExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeSubscriptionInvoiceBillApi();
            var payload = new SubscriptionInvoiceBillPayload(); // SubscriptionInvoiceBillPayload | Subscription invoice bill payload

            try
            {
                // show backoffice_subscription_invoice_bill
                Subscription_invoice_bill result = apiInstance.backofficeSubscriptionInvoiceBillShow(payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeSubscriptionInvoiceBillApi.backofficeSubscriptionInvoiceBillShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeSubscriptionInvoiceBillApi();
$payload = ; // SubscriptionInvoiceBillPayload | Subscription invoice bill payload

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

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeSubscriptionInvoiceBillApi->new();
my $payload = WWW::SwaggerClient::Object::SubscriptionInvoiceBillPayload->new(); # SubscriptionInvoiceBillPayload | Subscription invoice bill payload

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeSubscriptionInvoiceBillApi()
payload =  # SubscriptionInvoiceBillPayload | Subscription invoice bill payload

try: 
    # show backoffice_subscription_invoice_bill
    api_response = api_instance.backoffice_subscription_invoice_bill_show(payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeSubscriptionInvoiceBillApi->backofficeSubscriptionInvoiceBillShow: %s\n" % e)

Parameters

Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request


BackofficeSubscriptionOrder

backofficeSubscriptionOrderCheckout

checkout backoffice_subscription_order

Checkout the subscription order


/0.0.1/backoffice/subscription_orders/{id}/checkout

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/subscription_orders/{id}/checkout"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeSubscriptionOrderApi;

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

public class BackofficeSubscriptionOrderApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeSubscriptionOrderApi apiInstance = new BackofficeSubscriptionOrderApi();
        String id = id_example; // String | Subscription order ID
        SubscriptionOrderCheckoutPayload payload = ; // SubscriptionOrderCheckoutPayload | Subscription order checkout payload
        String organisation = organisation_example; // String | 
        try {
            Subscription_order result = apiInstance.backofficeSubscriptionOrderCheckout(id, payload, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionOrderApi#backofficeSubscriptionOrderCheckout");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeSubscriptionOrderApi;

public class BackofficeSubscriptionOrderApiExample {

    public static void main(String[] args) {
        BackofficeSubscriptionOrderApi apiInstance = new BackofficeSubscriptionOrderApi();
        String id = id_example; // String | Subscription order ID
        SubscriptionOrderCheckoutPayload payload = ; // SubscriptionOrderCheckoutPayload | Subscription order checkout payload
        String organisation = organisation_example; // String | 
        try {
            Subscription_order result = apiInstance.backofficeSubscriptionOrderCheckout(id, payload, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionOrderApi#backofficeSubscriptionOrderCheckout");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Subscription order ID
SubscriptionOrderCheckoutPayload *payload = ; // Subscription order checkout payload
String *organisation = organisation_example; //  (optional)

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

// checkout backoffice_subscription_order
[apiInstance backofficeSubscriptionOrderCheckoutWith:id
    payload:payload
    organisation:organisation
              completionHandler: ^(Subscription_order output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeSubscriptionOrderApi()

var id = id_example; // {String} Subscription order ID

var payload = ; // {SubscriptionOrderCheckoutPayload} Subscription order checkout payload

var opts = { 
  'organisation': organisation_example // {String} 
};
api.backofficeSubscriptionOrderCheckout(id, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeSubscriptionOrderCheckoutExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeSubscriptionOrderApi();
            var id = id_example;  // String | Subscription order ID
            var payload = new SubscriptionOrderCheckoutPayload(); // SubscriptionOrderCheckoutPayload | Subscription order checkout payload
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // checkout backoffice_subscription_order
                Subscription_order result = apiInstance.backofficeSubscriptionOrderCheckout(id, payload, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeSubscriptionOrderApi.backofficeSubscriptionOrderCheckout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeSubscriptionOrderApi();
$id = id_example; // String | Subscription order ID
$payload = ; // SubscriptionOrderCheckoutPayload | Subscription order checkout payload
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeSubscriptionOrderCheckout($id, $payload, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeSubscriptionOrderApi->backofficeSubscriptionOrderCheckout: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeSubscriptionOrderApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeSubscriptionOrderApi->new();
my $id = id_example; # String | Subscription order ID
my $payload = WWW::SwaggerClient::Object::SubscriptionOrderCheckoutPayload->new(); # SubscriptionOrderCheckoutPayload | Subscription order checkout payload
my $organisation = organisation_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeSubscriptionOrderApi()
id = id_example # String | Subscription order ID
payload =  # SubscriptionOrderCheckoutPayload | Subscription order checkout payload
organisation = organisation_example # String |  (optional)

try: 
    # checkout backoffice_subscription_order
    api_response = api_instance.backoffice_subscription_order_checkout(id, payload, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeSubscriptionOrderApi->backofficeSubscriptionOrderCheckout: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Subscription order ID
Required
Header parameters
Name Description
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeSubscriptionOrderCreate

create backoffice_subscription_order

Create a new subscription order.


/0.0.1/backoffice/subscription_orders

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/subscription_orders"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeSubscriptionOrderApi;

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

public class BackofficeSubscriptionOrderApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeSubscriptionOrderApi apiInstance = new BackofficeSubscriptionOrderApi();
        SubscriptionOrderPayload payload = ; // SubscriptionOrderPayload | Subscription order payload
        String organisation = organisation_example; // String | 
        try {
            Subscription_order result = apiInstance.backofficeSubscriptionOrderCreate(payload, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionOrderApi#backofficeSubscriptionOrderCreate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeSubscriptionOrderApi;

public class BackofficeSubscriptionOrderApiExample {

    public static void main(String[] args) {
        BackofficeSubscriptionOrderApi apiInstance = new BackofficeSubscriptionOrderApi();
        SubscriptionOrderPayload payload = ; // SubscriptionOrderPayload | Subscription order payload
        String organisation = organisation_example; // String | 
        try {
            Subscription_order result = apiInstance.backofficeSubscriptionOrderCreate(payload, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionOrderApi#backofficeSubscriptionOrderCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

SubscriptionOrderPayload *payload = ; // Subscription order payload
String *organisation = organisation_example; //  (optional)

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

// create backoffice_subscription_order
[apiInstance backofficeSubscriptionOrderCreateWith:payload
    organisation:organisation
              completionHandler: ^(Subscription_order output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeSubscriptionOrderApi()

var payload = ; // {SubscriptionOrderPayload} Subscription order payload

var opts = { 
  'organisation': organisation_example // {String} 
};
api.backofficeSubscriptionOrderCreate(payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeSubscriptionOrderCreateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeSubscriptionOrderApi();
            var payload = new SubscriptionOrderPayload(); // SubscriptionOrderPayload | Subscription order payload
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // create backoffice_subscription_order
                Subscription_order result = apiInstance.backofficeSubscriptionOrderCreate(payload, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeSubscriptionOrderApi.backofficeSubscriptionOrderCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeSubscriptionOrderApi();
$payload = ; // SubscriptionOrderPayload | Subscription order payload
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeSubscriptionOrderCreate($payload, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeSubscriptionOrderApi->backofficeSubscriptionOrderCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeSubscriptionOrderApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeSubscriptionOrderApi->new();
my $payload = WWW::SwaggerClient::Object::SubscriptionOrderPayload->new(); # SubscriptionOrderPayload | Subscription order payload
my $organisation = organisation_example; # String | 

eval { 
    my $result = $api_instance->backofficeSubscriptionOrderCreate(payload => $payload, organisation => $organisation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeSubscriptionOrderApi->backofficeSubscriptionOrderCreate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeSubscriptionOrderApi()
payload =  # SubscriptionOrderPayload | Subscription order payload
organisation = organisation_example # String |  (optional)

try: 
    # create backoffice_subscription_order
    api_response = api_instance.backoffice_subscription_order_create(payload, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeSubscriptionOrderApi->backofficeSubscriptionOrderCreate: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request


backofficeSubscriptionOrderList

list backoffice_subscription_order

Retrieve all organisations.


/0.0.1/backoffice/subscription_orders/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/subscription_orders/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeSubscriptionOrderApi;

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

public class BackofficeSubscriptionOrderApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeSubscriptionOrderApi apiInstance = new BackofficeSubscriptionOrderApi();
        SubscriptionOrderCollectionPayload payload = ; // SubscriptionOrderCollectionPayload | A backoffice subscription order collection payload
        String organisation = organisation_example; // String | 
        try {
            Subscription_order_collection result = apiInstance.backofficeSubscriptionOrderList(payload, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionOrderApi#backofficeSubscriptionOrderList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeSubscriptionOrderApi;

public class BackofficeSubscriptionOrderApiExample {

    public static void main(String[] args) {
        BackofficeSubscriptionOrderApi apiInstance = new BackofficeSubscriptionOrderApi();
        SubscriptionOrderCollectionPayload payload = ; // SubscriptionOrderCollectionPayload | A backoffice subscription order collection payload
        String organisation = organisation_example; // String | 
        try {
            Subscription_order_collection result = apiInstance.backofficeSubscriptionOrderList(payload, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionOrderApi#backofficeSubscriptionOrderList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

SubscriptionOrderCollectionPayload *payload = ; // A backoffice subscription order collection payload
String *organisation = organisation_example; //  (optional)

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

// list backoffice_subscription_order
[apiInstance backofficeSubscriptionOrderListWith:payload
    organisation:organisation
              completionHandler: ^(Subscription_order_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeSubscriptionOrderApi()

var payload = ; // {SubscriptionOrderCollectionPayload} A backoffice subscription order collection payload

var opts = { 
  'organisation': organisation_example // {String} 
};
api.backofficeSubscriptionOrderList(payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeSubscriptionOrderListExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeSubscriptionOrderApi();
            var payload = new SubscriptionOrderCollectionPayload(); // SubscriptionOrderCollectionPayload | A backoffice subscription order collection payload
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // list backoffice_subscription_order
                Subscription_order_collection result = apiInstance.backofficeSubscriptionOrderList(payload, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeSubscriptionOrderApi.backofficeSubscriptionOrderList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeSubscriptionOrderApi();
$payload = ; // SubscriptionOrderCollectionPayload | A backoffice subscription order collection payload
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeSubscriptionOrderList($payload, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeSubscriptionOrderApi->backofficeSubscriptionOrderList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeSubscriptionOrderApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeSubscriptionOrderApi->new();
my $payload = WWW::SwaggerClient::Object::SubscriptionOrderCollectionPayload->new(); # SubscriptionOrderCollectionPayload | A backoffice subscription order collection payload
my $organisation = organisation_example; # String | 

eval { 
    my $result = $api_instance->backofficeSubscriptionOrderList(payload => $payload, organisation => $organisation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeSubscriptionOrderApi->backofficeSubscriptionOrderList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeSubscriptionOrderApi()
payload =  # SubscriptionOrderCollectionPayload | A backoffice subscription order collection payload
organisation = organisation_example # String |  (optional)

try: 
    # list backoffice_subscription_order
    api_response = api_instance.backoffice_subscription_order_list(payload, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeSubscriptionOrderApi->backofficeSubscriptionOrderList: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeSubscriptionOrderShow

show backoffice_subscription_order

Retrieve subscription order with given id.


/0.0.1/backoffice/subscription_orders/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/subscription_orders/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeSubscriptionOrderApi;

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

public class BackofficeSubscriptionOrderApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeSubscriptionOrderApi apiInstance = new BackofficeSubscriptionOrderApi();
        String id = id_example; // String | Subscription order ID
        String organisation = organisation_example; // String | 
        try {
            Subscription_order result = apiInstance.backofficeSubscriptionOrderShow(id, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionOrderApi#backofficeSubscriptionOrderShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeSubscriptionOrderApi;

public class BackofficeSubscriptionOrderApiExample {

    public static void main(String[] args) {
        BackofficeSubscriptionOrderApi apiInstance = new BackofficeSubscriptionOrderApi();
        String id = id_example; // String | Subscription order ID
        String organisation = organisation_example; // String | 
        try {
            Subscription_order result = apiInstance.backofficeSubscriptionOrderShow(id, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionOrderApi#backofficeSubscriptionOrderShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Subscription order ID
String *organisation = organisation_example; //  (optional)

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

// show backoffice_subscription_order
[apiInstance backofficeSubscriptionOrderShowWith:id
    organisation:organisation
              completionHandler: ^(Subscription_order output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeSubscriptionOrderApi()

var id = id_example; // {String} Subscription order ID

var opts = { 
  'organisation': organisation_example // {String} 
};
api.backofficeSubscriptionOrderShow(id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeSubscriptionOrderShowExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeSubscriptionOrderApi();
            var id = id_example;  // String | Subscription order ID
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // show backoffice_subscription_order
                Subscription_order result = apiInstance.backofficeSubscriptionOrderShow(id, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeSubscriptionOrderApi.backofficeSubscriptionOrderShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeSubscriptionOrderApi();
$id = id_example; // String | Subscription order ID
$organisation = organisation_example; // String | 

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

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeSubscriptionOrderApi->new();
my $id = id_example; # String | Subscription order ID
my $organisation = organisation_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeSubscriptionOrderApi()
id = id_example # String | Subscription order ID
organisation = organisation_example # String |  (optional)

try: 
    # show backoffice_subscription_order
    api_response = api_instance.backoffice_subscription_order_show(id, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeSubscriptionOrderApi->backofficeSubscriptionOrderShow: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Subscription order ID
Required
Header parameters
Name Description
Organisation
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeSubscriptionOrderUpdate

update backoffice_subscription_order

Change subscription order


/0.0.1/backoffice/subscription_orders/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/subscription_orders/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeSubscriptionOrderApi;

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

public class BackofficeSubscriptionOrderApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeSubscriptionOrderApi apiInstance = new BackofficeSubscriptionOrderApi();
        String id = id_example; // String | Order ID
        SubscriptionOrderUpdatePayload payload = ; // SubscriptionOrderUpdatePayload | Subscription order update payload
        String organisation = organisation_example; // String | 
        try {
            Subscription_order result = apiInstance.backofficeSubscriptionOrderUpdate(id, payload, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionOrderApi#backofficeSubscriptionOrderUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeSubscriptionOrderApi;

public class BackofficeSubscriptionOrderApiExample {

    public static void main(String[] args) {
        BackofficeSubscriptionOrderApi apiInstance = new BackofficeSubscriptionOrderApi();
        String id = id_example; // String | Order ID
        SubscriptionOrderUpdatePayload payload = ; // SubscriptionOrderUpdatePayload | Subscription order update payload
        String organisation = organisation_example; // String | 
        try {
            Subscription_order result = apiInstance.backofficeSubscriptionOrderUpdate(id, payload, organisation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionOrderApi#backofficeSubscriptionOrderUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Order ID
SubscriptionOrderUpdatePayload *payload = ; // Subscription order update payload
String *organisation = organisation_example; //  (optional)

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

// update backoffice_subscription_order
[apiInstance backofficeSubscriptionOrderUpdateWith:id
    payload:payload
    organisation:organisation
              completionHandler: ^(Subscription_order output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeSubscriptionOrderApi()

var id = id_example; // {String} Order ID

var payload = ; // {SubscriptionOrderUpdatePayload} Subscription order update payload

var opts = { 
  'organisation': organisation_example // {String} 
};
api.backofficeSubscriptionOrderUpdate(id, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeSubscriptionOrderUpdateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeSubscriptionOrderApi();
            var id = id_example;  // String | Order ID
            var payload = new SubscriptionOrderUpdatePayload(); // SubscriptionOrderUpdatePayload | Subscription order update payload
            var organisation = organisation_example;  // String |  (optional) 

            try
            {
                // update backoffice_subscription_order
                Subscription_order result = apiInstance.backofficeSubscriptionOrderUpdate(id, payload, organisation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeSubscriptionOrderApi.backofficeSubscriptionOrderUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeSubscriptionOrderApi();
$id = id_example; // String | Order ID
$payload = ; // SubscriptionOrderUpdatePayload | Subscription order update payload
$organisation = organisation_example; // String | 

try {
    $result = $api_instance->backofficeSubscriptionOrderUpdate($id, $payload, $organisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeSubscriptionOrderApi->backofficeSubscriptionOrderUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeSubscriptionOrderApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeSubscriptionOrderApi->new();
my $id = id_example; # String | Order ID
my $payload = WWW::SwaggerClient::Object::SubscriptionOrderUpdatePayload->new(); # SubscriptionOrderUpdatePayload | Subscription order update payload
my $organisation = organisation_example; # String | 

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeSubscriptionOrderApi()
id = id_example # String | Order ID
payload =  # SubscriptionOrderUpdatePayload | Subscription order update payload
organisation = organisation_example # String |  (optional)

try: 
    # update backoffice_subscription_order
    api_response = api_instance.backoffice_subscription_order_update(id, payload, organisation=organisation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeSubscriptionOrderApi->backofficeSubscriptionOrderUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Order ID
Required
Header parameters
Name Description
Organisation
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


BackofficeSubscriptionPlan

backofficeSubscriptionPlanList

list backoffice_subscription_plan

Retrieve all subscription plans.


/0.0.1/backoffice/subscription_plans/list

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/backoffice/subscription_plans/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeSubscriptionPlanApi;

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

public class BackofficeSubscriptionPlanApiExample {

    public static void main(String[] args) {
        
        BackofficeSubscriptionPlanApi apiInstance = new BackofficeSubscriptionPlanApi();
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Subscription_plan_collection result = apiInstance.backofficeSubscriptionPlanList(acceptLanguage, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionPlanApi#backofficeSubscriptionPlanList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeSubscriptionPlanApi;

public class BackofficeSubscriptionPlanApiExample {

    public static void main(String[] args) {
        BackofficeSubscriptionPlanApi apiInstance = new BackofficeSubscriptionPlanApi();
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Subscription_plan_collection result = apiInstance.backofficeSubscriptionPlanList(acceptLanguage, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionPlanApi#backofficeSubscriptionPlanList");
            e.printStackTrace();
        }
    }
}
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// list backoffice_subscription_plan
[apiInstance backofficeSubscriptionPlanListWith:acceptLanguage
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(Subscription_plan_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.BackofficeSubscriptionPlanApi()

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeSubscriptionPlanList(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeSubscriptionPlanListExample
    {
        public void main()
        {
            
            var apiInstance = new BackofficeSubscriptionPlanApi();
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // list backoffice_subscription_plan
                Subscription_plan_collection result = apiInstance.backofficeSubscriptionPlanList(acceptLanguage, organisation, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeSubscriptionPlanApi.backofficeSubscriptionPlanList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BackofficeSubscriptionPlanApi();
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->backofficeSubscriptionPlanList($acceptLanguage, $organisation, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeSubscriptionPlanApi->backofficeSubscriptionPlanList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeSubscriptionPlanApi;

my $api_instance = WWW::SwaggerClient::BackofficeSubscriptionPlanApi->new();
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->backofficeSubscriptionPlanList(acceptLanguage => $acceptLanguage, organisation => $organisation, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeSubscriptionPlanApi->backofficeSubscriptionPlanList: $@\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.BackofficeSubscriptionPlanApi()
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # list backoffice_subscription_plan
    api_response = api_instance.backoffice_subscription_plan_list(acceptLanguage=acceptLanguage, organisation=organisation, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeSubscriptionPlanApi->backofficeSubscriptionPlanList: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Organisation
String
X-Forwarded-For
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeSubscriptionPlanShow

show backoffice_subscription_plan

Retrieve a subscription plan.


/0.0.1/backoffice/subscription_plans/{id}

Usage and SDK Samples

curl -X GET "https://api.quriobot.com/0.0.1/backoffice/subscription_plans/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeSubscriptionPlanApi;

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

public class BackofficeSubscriptionPlanApiExample {

    public static void main(String[] args) {
        
        BackofficeSubscriptionPlanApi apiInstance = new BackofficeSubscriptionPlanApi();
        String id = id_example; // String | Subscription plan ID
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Subscription_plan result = apiInstance.backofficeSubscriptionPlanShow(id, acceptLanguage, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionPlanApi#backofficeSubscriptionPlanShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeSubscriptionPlanApi;

public class BackofficeSubscriptionPlanApiExample {

    public static void main(String[] args) {
        BackofficeSubscriptionPlanApi apiInstance = new BackofficeSubscriptionPlanApi();
        String id = id_example; // String | Subscription plan ID
        String acceptLanguage = acceptLanguage_example; // String | 
        String organisation = organisation_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Subscription_plan result = apiInstance.backofficeSubscriptionPlanShow(id, acceptLanguage, organisation, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionPlanApi#backofficeSubscriptionPlanShow");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Subscription plan ID
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *organisation = organisation_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

// show backoffice_subscription_plan
[apiInstance backofficeSubscriptionPlanShowWith:id
    acceptLanguage:acceptLanguage
    organisation:organisation
    xForwardedFor:xForwardedFor
              completionHandler: ^(Subscription_plan output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.BackofficeSubscriptionPlanApi()

var id = id_example; // {String} Subscription plan ID

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'organisation': organisation_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.backofficeSubscriptionPlanShow(id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeSubscriptionPlanShowExample
    {
        public void main()
        {
            
            var apiInstance = new BackofficeSubscriptionPlanApi();
            var id = id_example;  // String | Subscription plan ID
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var organisation = organisation_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // show backoffice_subscription_plan
                Subscription_plan result = apiInstance.backofficeSubscriptionPlanShow(id, acceptLanguage, organisation, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeSubscriptionPlanApi.backofficeSubscriptionPlanShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BackofficeSubscriptionPlanApi();
$id = id_example; // String | Subscription plan ID
$acceptLanguage = acceptLanguage_example; // String | 
$organisation = organisation_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->backofficeSubscriptionPlanShow($id, $acceptLanguage, $organisation, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeSubscriptionPlanApi->backofficeSubscriptionPlanShow: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeSubscriptionPlanApi;

my $api_instance = WWW::SwaggerClient::BackofficeSubscriptionPlanApi->new();
my $id = id_example; # String | Subscription plan ID
my $acceptLanguage = acceptLanguage_example; # String | 
my $organisation = organisation_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->backofficeSubscriptionPlanShow(id => $id, acceptLanguage => $acceptLanguage, organisation => $organisation, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeSubscriptionPlanApi->backofficeSubscriptionPlanShow: $@\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.BackofficeSubscriptionPlanApi()
id = id_example # String | Subscription plan ID
acceptLanguage = acceptLanguage_example # String |  (optional)
organisation = organisation_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # show backoffice_subscription_plan
    api_response = api_instance.backoffice_subscription_plan_show(id, acceptLanguage=acceptLanguage, organisation=organisation, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeSubscriptionPlanApi->backofficeSubscriptionPlanShow: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Subscription plan ID
Required
Header parameters
Name Description
Accept-Language
String
Organisation
String
X-Forwarded-For
String

Responses

Status: 200 - OK

Status: 400 - Bad Request


BackofficeSubscriptionVoucher

backofficeSubscriptionVoucherDownload

download backoffice_subscription_voucher

Download all vouchers.


/0.0.1/backoffice/subscription_vouchers/list/download

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/subscription_vouchers/list/download"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeSubscriptionVoucherApi;

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

public class BackofficeSubscriptionVoucherApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeSubscriptionVoucherApi apiInstance = new BackofficeSubscriptionVoucherApi();
        String group = group_example; // String | 
        SubscriptionVoucherCollectionPayload payload = ; // SubscriptionVoucherCollectionPayload | A backoffice subscription voucher  collection payload
        try {
            Download result = apiInstance.backofficeSubscriptionVoucherDownload(group, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionVoucherApi#backofficeSubscriptionVoucherDownload");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeSubscriptionVoucherApi;

public class BackofficeSubscriptionVoucherApiExample {

    public static void main(String[] args) {
        BackofficeSubscriptionVoucherApi apiInstance = new BackofficeSubscriptionVoucherApi();
        String group = group_example; // String | 
        SubscriptionVoucherCollectionPayload payload = ; // SubscriptionVoucherCollectionPayload | A backoffice subscription voucher  collection payload
        try {
            Download result = apiInstance.backofficeSubscriptionVoucherDownload(group, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionVoucherApi#backofficeSubscriptionVoucherDownload");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *group = group_example; // 
SubscriptionVoucherCollectionPayload *payload = ; // A backoffice subscription voucher  collection payload

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

// download backoffice_subscription_voucher
[apiInstance backofficeSubscriptionVoucherDownloadWith:group
    payload:payload
              completionHandler: ^(Download output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeSubscriptionVoucherApi()

var group = group_example; // {String} 

var payload = ; // {SubscriptionVoucherCollectionPayload} A backoffice subscription voucher  collection payload

api.backofficeSubscriptionVoucherDownload(group, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeSubscriptionVoucherDownloadExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeSubscriptionVoucherApi();
            var group = group_example;  // String | 
            var payload = new SubscriptionVoucherCollectionPayload(); // SubscriptionVoucherCollectionPayload | A backoffice subscription voucher  collection payload

            try
            {
                // download backoffice_subscription_voucher
                Download result = apiInstance.backofficeSubscriptionVoucherDownload(group, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeSubscriptionVoucherApi.backofficeSubscriptionVoucherDownload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeSubscriptionVoucherApi();
$group = group_example; // String | 
$payload = ; // SubscriptionVoucherCollectionPayload | A backoffice subscription voucher  collection payload

try {
    $result = $api_instance->backofficeSubscriptionVoucherDownload($group, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeSubscriptionVoucherApi->backofficeSubscriptionVoucherDownload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeSubscriptionVoucherApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeSubscriptionVoucherApi->new();
my $group = group_example; # String | 
my $payload = WWW::SwaggerClient::Object::SubscriptionVoucherCollectionPayload->new(); # SubscriptionVoucherCollectionPayload | A backoffice subscription voucher  collection payload

eval { 
    my $result = $api_instance->backofficeSubscriptionVoucherDownload(group => $group, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeSubscriptionVoucherApi->backofficeSubscriptionVoucherDownload: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeSubscriptionVoucherApi()
group = group_example # String | 
payload =  # SubscriptionVoucherCollectionPayload | A backoffice subscription voucher  collection payload

try: 
    # download backoffice_subscription_voucher
    api_response = api_instance.backoffice_subscription_voucher_download(group, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeSubscriptionVoucherApi->backofficeSubscriptionVoucherDownload: %s\n" % e)

Parameters

Header parameters
Name Description
Group*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeSubscriptionVoucherList

list backoffice_subscription_voucher

Retrieve all vouchers.


/0.0.1/backoffice/subscription_vouchers/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/subscription_vouchers/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeSubscriptionVoucherApi;

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

public class BackofficeSubscriptionVoucherApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeSubscriptionVoucherApi apiInstance = new BackofficeSubscriptionVoucherApi();
        String group = group_example; // String | 
        SubscriptionVoucherCollectionPayload payload = ; // SubscriptionVoucherCollectionPayload | A backoffice subscription voucher  collection payload
        try {
            Subscription_voucher_collection result = apiInstance.backofficeSubscriptionVoucherList(group, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionVoucherApi#backofficeSubscriptionVoucherList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeSubscriptionVoucherApi;

public class BackofficeSubscriptionVoucherApiExample {

    public static void main(String[] args) {
        BackofficeSubscriptionVoucherApi apiInstance = new BackofficeSubscriptionVoucherApi();
        String group = group_example; // String | 
        SubscriptionVoucherCollectionPayload payload = ; // SubscriptionVoucherCollectionPayload | A backoffice subscription voucher  collection payload
        try {
            Subscription_voucher_collection result = apiInstance.backofficeSubscriptionVoucherList(group, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionVoucherApi#backofficeSubscriptionVoucherList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *group = group_example; // 
SubscriptionVoucherCollectionPayload *payload = ; // A backoffice subscription voucher  collection payload

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

// list backoffice_subscription_voucher
[apiInstance backofficeSubscriptionVoucherListWith:group
    payload:payload
              completionHandler: ^(Subscription_voucher_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeSubscriptionVoucherApi()

var group = group_example; // {String} 

var payload = ; // {SubscriptionVoucherCollectionPayload} A backoffice subscription voucher  collection payload

api.backofficeSubscriptionVoucherList(group, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeSubscriptionVoucherListExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeSubscriptionVoucherApi();
            var group = group_example;  // String | 
            var payload = new SubscriptionVoucherCollectionPayload(); // SubscriptionVoucherCollectionPayload | A backoffice subscription voucher  collection payload

            try
            {
                // list backoffice_subscription_voucher
                Subscription_voucher_collection result = apiInstance.backofficeSubscriptionVoucherList(group, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeSubscriptionVoucherApi.backofficeSubscriptionVoucherList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeSubscriptionVoucherApi();
$group = group_example; // String | 
$payload = ; // SubscriptionVoucherCollectionPayload | A backoffice subscription voucher  collection payload

try {
    $result = $api_instance->backofficeSubscriptionVoucherList($group, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeSubscriptionVoucherApi->backofficeSubscriptionVoucherList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeSubscriptionVoucherApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeSubscriptionVoucherApi->new();
my $group = group_example; # String | 
my $payload = WWW::SwaggerClient::Object::SubscriptionVoucherCollectionPayload->new(); # SubscriptionVoucherCollectionPayload | A backoffice subscription voucher  collection payload

eval { 
    my $result = $api_instance->backofficeSubscriptionVoucherList(group => $group, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeSubscriptionVoucherApi->backofficeSubscriptionVoucherList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeSubscriptionVoucherApi()
group = group_example # String | 
payload =  # SubscriptionVoucherCollectionPayload | A backoffice subscription voucher  collection payload

try: 
    # list backoffice_subscription_voucher
    api_response = api_instance.backoffice_subscription_voucher_list(group, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeSubscriptionVoucherApi->backofficeSubscriptionVoucherList: %s\n" % e)

Parameters

Header parameters
Name Description
Group*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


BackofficeSubscriptionVoucherGroup

backofficeSubscriptionVoucherGroupCreate

create backoffice_subscription_voucher_group

Create a new subscription voucher group.


/0.0.1/backoffice/subscription_voucher_groups

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/subscription_voucher_groups"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeSubscriptionVoucherGroupApi;

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

public class BackofficeSubscriptionVoucherGroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeSubscriptionVoucherGroupApi apiInstance = new BackofficeSubscriptionVoucherGroupApi();
        SubscriptionVoucherGroupPayload payload = ; // SubscriptionVoucherGroupPayload | Subscription order payload
        try {
            Subscription_voucher_group result = apiInstance.backofficeSubscriptionVoucherGroupCreate(payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionVoucherGroupApi#backofficeSubscriptionVoucherGroupCreate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeSubscriptionVoucherGroupApi;

public class BackofficeSubscriptionVoucherGroupApiExample {

    public static void main(String[] args) {
        BackofficeSubscriptionVoucherGroupApi apiInstance = new BackofficeSubscriptionVoucherGroupApi();
        SubscriptionVoucherGroupPayload payload = ; // SubscriptionVoucherGroupPayload | Subscription order payload
        try {
            Subscription_voucher_group result = apiInstance.backofficeSubscriptionVoucherGroupCreate(payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionVoucherGroupApi#backofficeSubscriptionVoucherGroupCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

SubscriptionVoucherGroupPayload *payload = ; // Subscription order payload

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

// create backoffice_subscription_voucher_group
[apiInstance backofficeSubscriptionVoucherGroupCreateWith:payload
              completionHandler: ^(Subscription_voucher_group output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeSubscriptionVoucherGroupApi()

var payload = ; // {SubscriptionVoucherGroupPayload} Subscription order payload

api.backofficeSubscriptionVoucherGroupCreate(payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeSubscriptionVoucherGroupCreateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeSubscriptionVoucherGroupApi();
            var payload = new SubscriptionVoucherGroupPayload(); // SubscriptionVoucherGroupPayload | Subscription order payload

            try
            {
                // create backoffice_subscription_voucher_group
                Subscription_voucher_group result = apiInstance.backofficeSubscriptionVoucherGroupCreate(payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeSubscriptionVoucherGroupApi.backofficeSubscriptionVoucherGroupCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeSubscriptionVoucherGroupApi();
$payload = ; // SubscriptionVoucherGroupPayload | Subscription order payload

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

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeSubscriptionVoucherGroupApi->new();
my $payload = WWW::SwaggerClient::Object::SubscriptionVoucherGroupPayload->new(); # SubscriptionVoucherGroupPayload | Subscription order payload

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeSubscriptionVoucherGroupApi()
payload =  # SubscriptionVoucherGroupPayload | Subscription order payload

try: 
    # create backoffice_subscription_voucher_group
    api_response = api_instance.backoffice_subscription_voucher_group_create(payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeSubscriptionVoucherGroupApi->backofficeSubscriptionVoucherGroupCreate: %s\n" % e)

Parameters

Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeSubscriptionVoucherGroupList

list backoffice_subscription_voucher_group

Retrieve all voucher groups.


/0.0.1/backoffice/subscription_voucher_groups/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/subscription_voucher_groups/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeSubscriptionVoucherGroupApi;

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

public class BackofficeSubscriptionVoucherGroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeSubscriptionVoucherGroupApi apiInstance = new BackofficeSubscriptionVoucherGroupApi();
        SubscriptionVoucherGroupCollectionPayload payload = ; // SubscriptionVoucherGroupCollectionPayload | A backoffice subscription voucher group collection payload
        try {
            Subscription_voucher_group_collection result = apiInstance.backofficeSubscriptionVoucherGroupList(payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionVoucherGroupApi#backofficeSubscriptionVoucherGroupList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeSubscriptionVoucherGroupApi;

public class BackofficeSubscriptionVoucherGroupApiExample {

    public static void main(String[] args) {
        BackofficeSubscriptionVoucherGroupApi apiInstance = new BackofficeSubscriptionVoucherGroupApi();
        SubscriptionVoucherGroupCollectionPayload payload = ; // SubscriptionVoucherGroupCollectionPayload | A backoffice subscription voucher group collection payload
        try {
            Subscription_voucher_group_collection result = apiInstance.backofficeSubscriptionVoucherGroupList(payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionVoucherGroupApi#backofficeSubscriptionVoucherGroupList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

SubscriptionVoucherGroupCollectionPayload *payload = ; // A backoffice subscription voucher group collection payload

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

// list backoffice_subscription_voucher_group
[apiInstance backofficeSubscriptionVoucherGroupListWith:payload
              completionHandler: ^(Subscription_voucher_group_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeSubscriptionVoucherGroupApi()

var payload = ; // {SubscriptionVoucherGroupCollectionPayload} A backoffice subscription voucher group collection payload

api.backofficeSubscriptionVoucherGroupList(payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeSubscriptionVoucherGroupListExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeSubscriptionVoucherGroupApi();
            var payload = new SubscriptionVoucherGroupCollectionPayload(); // SubscriptionVoucherGroupCollectionPayload | A backoffice subscription voucher group collection payload

            try
            {
                // list backoffice_subscription_voucher_group
                Subscription_voucher_group_collection result = apiInstance.backofficeSubscriptionVoucherGroupList(payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeSubscriptionVoucherGroupApi.backofficeSubscriptionVoucherGroupList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeSubscriptionVoucherGroupApi();
$payload = ; // SubscriptionVoucherGroupCollectionPayload | A backoffice subscription voucher group collection payload

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

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeSubscriptionVoucherGroupApi->new();
my $payload = WWW::SwaggerClient::Object::SubscriptionVoucherGroupCollectionPayload->new(); # SubscriptionVoucherGroupCollectionPayload | A backoffice subscription voucher group collection payload

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeSubscriptionVoucherGroupApi()
payload =  # SubscriptionVoucherGroupCollectionPayload | A backoffice subscription voucher group collection payload

try: 
    # list backoffice_subscription_voucher_group
    api_response = api_instance.backoffice_subscription_voucher_group_list(payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeSubscriptionVoucherGroupApi->backofficeSubscriptionVoucherGroupList: %s\n" % e)

Parameters

Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


backofficeSubscriptionVoucherGroupShow

show backoffice_subscription_voucher_group

Retrieve subscription voucher group with given id.


/0.0.1/backoffice/subscription_voucher_groups/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/subscription_voucher_groups/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeSubscriptionVoucherGroupApi;

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

public class BackofficeSubscriptionVoucherGroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeSubscriptionVoucherGroupApi apiInstance = new BackofficeSubscriptionVoucherGroupApi();
        String id = id_example; // String | Voucher group ID
        try {
            Subscription_voucher_group result = apiInstance.backofficeSubscriptionVoucherGroupShow(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionVoucherGroupApi#backofficeSubscriptionVoucherGroupShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeSubscriptionVoucherGroupApi;

public class BackofficeSubscriptionVoucherGroupApiExample {

    public static void main(String[] args) {
        BackofficeSubscriptionVoucherGroupApi apiInstance = new BackofficeSubscriptionVoucherGroupApi();
        String id = id_example; // String | Voucher group ID
        try {
            Subscription_voucher_group result = apiInstance.backofficeSubscriptionVoucherGroupShow(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionVoucherGroupApi#backofficeSubscriptionVoucherGroupShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Voucher group ID

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

// show backoffice_subscription_voucher_group
[apiInstance backofficeSubscriptionVoucherGroupShowWith:id
              completionHandler: ^(Subscription_voucher_group output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeSubscriptionVoucherGroupApi()

var id = id_example; // {String} Voucher group ID

api.backofficeSubscriptionVoucherGroupShow(id).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeSubscriptionVoucherGroupShowExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeSubscriptionVoucherGroupApi();
            var id = id_example;  // String | Voucher group ID

            try
            {
                // show backoffice_subscription_voucher_group
                Subscription_voucher_group result = apiInstance.backofficeSubscriptionVoucherGroupShow(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeSubscriptionVoucherGroupApi.backofficeSubscriptionVoucherGroupShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeSubscriptionVoucherGroupApi();
$id = id_example; // String | Voucher group ID

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

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeSubscriptionVoucherGroupApi->new();
my $id = id_example; # String | Voucher group ID

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeSubscriptionVoucherGroupApi()
id = id_example # String | Voucher group ID

try: 
    # show backoffice_subscription_voucher_group
    api_response = api_instance.backoffice_subscription_voucher_group_show(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeSubscriptionVoucherGroupApi->backofficeSubscriptionVoucherGroupShow: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Voucher group ID
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


backofficeSubscriptionVoucherGroupUpdate

update backoffice_subscription_voucher_group

Change subscription voucher group


/0.0.1/backoffice/subscription_voucher_groups/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/subscription_voucher_groups/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeSubscriptionVoucherGroupApi;

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

public class BackofficeSubscriptionVoucherGroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeSubscriptionVoucherGroupApi apiInstance = new BackofficeSubscriptionVoucherGroupApi();
        String id = id_example; // String | Voucher group ID
        SubscriptionVoucherGroupPayload payload = ; // SubscriptionVoucherGroupPayload | Subscription order payload
        try {
            Subscription_voucher_group result = apiInstance.backofficeSubscriptionVoucherGroupUpdate(id, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionVoucherGroupApi#backofficeSubscriptionVoucherGroupUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeSubscriptionVoucherGroupApi;

public class BackofficeSubscriptionVoucherGroupApiExample {

    public static void main(String[] args) {
        BackofficeSubscriptionVoucherGroupApi apiInstance = new BackofficeSubscriptionVoucherGroupApi();
        String id = id_example; // String | Voucher group ID
        SubscriptionVoucherGroupPayload payload = ; // SubscriptionVoucherGroupPayload | Subscription order payload
        try {
            Subscription_voucher_group result = apiInstance.backofficeSubscriptionVoucherGroupUpdate(id, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeSubscriptionVoucherGroupApi#backofficeSubscriptionVoucherGroupUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *id = id_example; // Voucher group ID
SubscriptionVoucherGroupPayload *payload = ; // Subscription order payload

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

// update backoffice_subscription_voucher_group
[apiInstance backofficeSubscriptionVoucherGroupUpdateWith:id
    payload:payload
              completionHandler: ^(Subscription_voucher_group output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeSubscriptionVoucherGroupApi()

var id = id_example; // {String} Voucher group ID

var payload = ; // {SubscriptionVoucherGroupPayload} Subscription order payload

api.backofficeSubscriptionVoucherGroupUpdate(id, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeSubscriptionVoucherGroupUpdateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeSubscriptionVoucherGroupApi();
            var id = id_example;  // String | Voucher group ID
            var payload = new SubscriptionVoucherGroupPayload(); // SubscriptionVoucherGroupPayload | Subscription order payload

            try
            {
                // update backoffice_subscription_voucher_group
                Subscription_voucher_group result = apiInstance.backofficeSubscriptionVoucherGroupUpdate(id, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeSubscriptionVoucherGroupApi.backofficeSubscriptionVoucherGroupUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeSubscriptionVoucherGroupApi();
$id = id_example; // String | Voucher group ID
$payload = ; // SubscriptionVoucherGroupPayload | Subscription order payload

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

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeSubscriptionVoucherGroupApi->new();
my $id = id_example; # String | Voucher group ID
my $payload = WWW::SwaggerClient::Object::SubscriptionVoucherGroupPayload->new(); # SubscriptionVoucherGroupPayload | Subscription order payload

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeSubscriptionVoucherGroupApi()
id = id_example # String | Voucher group ID
payload =  # SubscriptionVoucherGroupPayload | Subscription order payload

try: 
    # update backoffice_subscription_voucher_group
    api_response = api_instance.backoffice_subscription_voucher_group_update(id, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeSubscriptionVoucherGroupApi->backofficeSubscriptionVoucherGroupUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Voucher group ID
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


BackofficeVersion

backofficeVersionCreate

create backoffice_version

Create object version


/0.0.1/backoffice/version

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/version"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeVersionApi;

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

public class BackofficeVersionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeVersionApi apiInstance = new BackofficeVersionApi();
        String organisation = organisation_example; // String | 
        ObjectVersionCreatePayload payload = ; // ObjectVersionCreatePayload | Object version payload
        try {
            Object_version result = apiInstance.backofficeVersionCreate(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeVersionApi#backofficeVersionCreate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeVersionApi;

public class BackofficeVersionApiExample {

    public static void main(String[] args) {
        BackofficeVersionApi apiInstance = new BackofficeVersionApi();
        String organisation = organisation_example; // String | 
        ObjectVersionCreatePayload payload = ; // ObjectVersionCreatePayload | Object version payload
        try {
            Object_version result = apiInstance.backofficeVersionCreate(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeVersionApi#backofficeVersionCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
ObjectVersionCreatePayload *payload = ; // Object version payload

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

// create backoffice_version
[apiInstance backofficeVersionCreateWith:organisation
    payload:payload
              completionHandler: ^(Object_version output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeVersionApi()

var organisation = organisation_example; // {String} 

var payload = ; // {ObjectVersionCreatePayload} Object version payload

api.backofficeVersionCreate(organisation, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeVersionCreateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeVersionApi();
            var organisation = organisation_example;  // String | 
            var payload = new ObjectVersionCreatePayload(); // ObjectVersionCreatePayload | Object version payload

            try
            {
                // create backoffice_version
                Object_version result = apiInstance.backofficeVersionCreate(organisation, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeVersionApi.backofficeVersionCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeVersionApi();
$organisation = organisation_example; // String | 
$payload = ; // ObjectVersionCreatePayload | Object version payload

try {
    $result = $api_instance->backofficeVersionCreate($organisation, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeVersionApi->backofficeVersionCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeVersionApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeVersionApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::ObjectVersionCreatePayload->new(); # ObjectVersionCreatePayload | Object version payload

eval { 
    my $result = $api_instance->backofficeVersionCreate(organisation => $organisation, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeVersionApi->backofficeVersionCreate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeVersionApi()
organisation = organisation_example # String | 
payload =  # ObjectVersionCreatePayload | Object version payload

try: 
    # create backoffice_version
    api_response = api_instance.backoffice_version_create(organisation, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeVersionApi->backofficeVersionCreate: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request


backofficeVersionList

list backoffice_version

Retrieve object versions.


/0.0.1/backoffice/version/list

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.quriobot.com/0.0.1/backoffice/version/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BackofficeVersionApi;

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

public class BackofficeVersionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        BackofficeVersionApi apiInstance = new BackofficeVersionApi();
        String organisation = organisation_example; // String | 
        ObjectVersionCollectionPayload payload = ; // ObjectVersionCollectionPayload | Object version collection payload
        try {
            Object_version_collection result = apiInstance.backofficeVersionList(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeVersionApi#backofficeVersionList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BackofficeVersionApi;

public class BackofficeVersionApiExample {

    public static void main(String[] args) {
        BackofficeVersionApi apiInstance = new BackofficeVersionApi();
        String organisation = organisation_example; // String | 
        ObjectVersionCollectionPayload payload = ; // ObjectVersionCollectionPayload | Object version collection payload
        try {
            Object_version_collection result = apiInstance.backofficeVersionList(organisation, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BackofficeVersionApi#backofficeVersionList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *organisation = organisation_example; // 
ObjectVersionCollectionPayload *payload = ; // Object version collection payload

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

// list backoffice_version
[apiInstance backofficeVersionListWith:organisation
    payload:payload
              completionHandler: ^(Object_version_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');
var defaultClient = QuriobotApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new QuriobotApi.BackofficeVersionApi()

var organisation = organisation_example; // {String} 

var payload = ; // {ObjectVersionCollectionPayload} Object version collection payload

api.backofficeVersionList(organisation, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class backofficeVersionListExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BackofficeVersionApi();
            var organisation = organisation_example;  // String | 
            var payload = new ObjectVersionCollectionPayload(); // ObjectVersionCollectionPayload | Object version collection payload

            try
            {
                // list backoffice_version
                Object_version_collection result = apiInstance.backofficeVersionList(organisation, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BackofficeVersionApi.backofficeVersionList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BackofficeVersionApi();
$organisation = organisation_example; // String | 
$payload = ; // ObjectVersionCollectionPayload | Object version collection payload

try {
    $result = $api_instance->backofficeVersionList($organisation, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackofficeVersionApi->backofficeVersionList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BackofficeVersionApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BackofficeVersionApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::ObjectVersionCollectionPayload->new(); # ObjectVersionCollectionPayload | Object version collection payload

eval { 
    my $result = $api_instance->backofficeVersionList(organisation => $organisation, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BackofficeVersionApi->backofficeVersionList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BackofficeVersionApi()
organisation = organisation_example # String | 
payload =  # ObjectVersionCollectionPayload | Object version collection payload

try: 
    # list backoffice_version
    api_response = api_instance.backoffice_version_list(organisation, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BackofficeVersionApi->backofficeVersionList: %s\n" % e)

Parameters

Header parameters
Name Description
Organisation*
String
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


Configuration

configurationConfiguration

configuration configuration

API configuration.


/configuration

Usage and SDK Samples

curl -X GET "https://api.quriobot.com/configuration"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConfigurationApi;

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

public class ConfigurationApiExample {

    public static void main(String[] args) {
        
        ConfigurationApi apiInstance = new ConfigurationApi();
        try {
            Api_configuration result = apiInstance.configurationConfiguration();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#configurationConfiguration");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConfigurationApi;

public class ConfigurationApiExample {

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

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

// configuration configuration
[apiInstance configurationConfigurationWithCompletionHandler: 
              ^(Api_configuration output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.ConfigurationApi()
api.configurationConfiguration().then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class configurationConfigurationExample
    {
        public void main()
        {
            
            var apiInstance = new ConfigurationApi();

            try
            {
                // configuration configuration
                Api_configuration result = apiInstance.configurationConfiguration();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigurationApi.configurationConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ConfigurationApi();

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

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

eval { 
    my $result = $api_instance->configurationConfiguration();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigurationApi->configurationConfiguration: $@\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.ConfigurationApi()

try: 
    # configuration configuration
    api_response = api_instance.configuration_configuration()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->configurationConfiguration: %s\n" % e)

Parameters

Responses

Status: 200 - OK


FrontendBot

frontendBotShow

show frontend_bot

Retrieve questionnaire with given organisation id/slug and bot id/slug.


/0.0.1/frontend/bots/by_domain/{id}/{slug}

Usage and SDK Samples

curl -X GET "https://api.quriobot.com/0.0.1/frontend/bots/by_domain/{id}/{slug}?organisation="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendBotApi;

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

public class FrontendBotApiExample {

    public static void main(String[] args) {
        
        FrontendBotApi apiInstance = new FrontendBotApi();
        String id = id_example; // String | Bot id or slug
        String slug = slug_example; // String | Bot slug
        String organisation = organisation_example; // String | Organisation id or slug
        String acceptLanguage = acceptLanguage_example; // String | 
        String referer = referer_example; // String | 
        Boolean xForEmbed = true; // Boolean | 
        Boolean xForEmbedCode = true; // Boolean | 
        String xForwardedFor = xForwardedFor_example; // String | 
        String xUserAgent = xUserAgent_example; // String | 
        Integer xVisitCount = 56; // Integer | 
        Boolean xWithEmbedCode = true; // Boolean | 
        try {
            Bot result = apiInstance.frontendBotShow(id, slug, organisation, acceptLanguage, referer, xForEmbed, xForEmbedCode, xForwardedFor, xUserAgent, xVisitCount, xWithEmbedCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendBotApi#frontendBotShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendBotApi;

public class FrontendBotApiExample {

    public static void main(String[] args) {
        FrontendBotApi apiInstance = new FrontendBotApi();
        String id = id_example; // String | Bot id or slug
        String slug = slug_example; // String | Bot slug
        String organisation = organisation_example; // String | Organisation id or slug
        String acceptLanguage = acceptLanguage_example; // String | 
        String referer = referer_example; // String | 
        Boolean xForEmbed = true; // Boolean | 
        Boolean xForEmbedCode = true; // Boolean | 
        String xForwardedFor = xForwardedFor_example; // String | 
        String xUserAgent = xUserAgent_example; // String | 
        Integer xVisitCount = 56; // Integer | 
        Boolean xWithEmbedCode = true; // Boolean | 
        try {
            Bot result = apiInstance.frontendBotShow(id, slug, organisation, acceptLanguage, referer, xForEmbed, xForEmbedCode, xForwardedFor, xUserAgent, xVisitCount, xWithEmbedCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendBotApi#frontendBotShow");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Bot id or slug
String *slug = slug_example; // Bot slug
String *organisation = organisation_example; // Organisation id or slug (optional)
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *referer = referer_example; //  (optional)
Boolean *xForEmbed = true; //  (optional)
Boolean *xForEmbedCode = true; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)
String *xUserAgent = xUserAgent_example; //  (optional)
Integer *xVisitCount = 56; //  (optional)
Boolean *xWithEmbedCode = true; //  (optional)

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

// show frontend_bot
[apiInstance frontendBotShowWith:id
    slug:slug
    organisation:organisation
    acceptLanguage:acceptLanguage
    referer:referer
    xForEmbed:xForEmbed
    xForEmbedCode:xForEmbedCode
    xForwardedFor:xForwardedFor
    xUserAgent:xUserAgent
    xVisitCount:xVisitCount
    xWithEmbedCode:xWithEmbedCode
              completionHandler: ^(Bot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendBotApi()

var id = id_example; // {String} Bot id or slug

var slug = slug_example; // {String} Bot slug

var opts = { 
  'organisation': organisation_example, // {String} Organisation id or slug
  'acceptLanguage': acceptLanguage_example, // {String} 
  'referer': referer_example, // {String} 
  'xForEmbed': true, // {Boolean} 
  'xForEmbedCode': true, // {Boolean} 
  'xForwardedFor': xForwardedFor_example, // {String} 
  'xUserAgent': xUserAgent_example, // {String} 
  'xVisitCount': 56, // {Integer} 
  'xWithEmbedCode': true // {Boolean} 
};
api.frontendBotShow(id, slug, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

namespace Example
{
    public class frontendBotShowExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendBotApi();
            var id = id_example;  // String | Bot id or slug
            var slug = slug_example;  // String | Bot slug
            var organisation = organisation_example;  // String | Organisation id or slug (optional) 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var referer = referer_example;  // String |  (optional) 
            var xForEmbed = true;  // Boolean |  (optional) 
            var xForEmbedCode = true;  // Boolean |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 
            var xUserAgent = xUserAgent_example;  // String |  (optional) 
            var xVisitCount = 56;  // Integer |  (optional) 
            var xWithEmbedCode = true;  // Boolean |  (optional) 

            try
            {
                // show frontend_bot
                Bot result = apiInstance.frontendBotShow(id, slug, organisation, acceptLanguage, referer, xForEmbed, xForEmbedCode, xForwardedFor, xUserAgent, xVisitCount, xWithEmbedCode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendBotApi.frontendBotShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendBotApi();
$id = id_example; // String | Bot id or slug
$slug = slug_example; // String | Bot slug
$organisation = organisation_example; // String | Organisation id or slug
$acceptLanguage = acceptLanguage_example; // String | 
$referer = referer_example; // String | 
$xForEmbed = true; // Boolean | 
$xForEmbedCode = true; // Boolean | 
$xForwardedFor = xForwardedFor_example; // String | 
$xUserAgent = xUserAgent_example; // String | 
$xVisitCount = 56; // Integer | 
$xWithEmbedCode = true; // Boolean | 

try {
    $result = $api_instance->frontendBotShow($id, $slug, $organisation, $acceptLanguage, $referer, $xForEmbed, $xForEmbedCode, $xForwardedFor, $xUserAgent, $xVisitCount, $xWithEmbedCode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FrontendBotApi->frontendBotShow: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendBotApi;

my $api_instance = WWW::SwaggerClient::FrontendBotApi->new();
my $id = id_example; # String | Bot id or slug
my $slug = slug_example; # String | Bot slug
my $organisation = organisation_example; # String | Organisation id or slug
my $acceptLanguage = acceptLanguage_example; # String | 
my $referer = referer_example; # String | 
my $xForEmbed = true; # Boolean | 
my $xForEmbedCode = true; # Boolean | 
my $xForwardedFor = xForwardedFor_example; # String | 
my $xUserAgent = xUserAgent_example; # String | 
my $xVisitCount = 56; # Integer | 
my $xWithEmbedCode = true; # Boolean | 

eval { 
    my $result = $api_instance->frontendBotShow(id => $id, slug => $slug, organisation => $organisation, acceptLanguage => $acceptLanguage, referer => $referer, xForEmbed => $xForEmbed, xForEmbedCode => $xForEmbedCode, xForwardedFor => $xForwardedFor, xUserAgent => $xUserAgent, xVisitCount => $xVisitCount, xWithEmbedCode => $xWithEmbedCode);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FrontendBotApi->frontendBotShow: $@\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.FrontendBotApi()
id = id_example # String | Bot id or slug
slug = slug_example # String | Bot slug
organisation = organisation_example # String | Organisation id or slug (optional)
acceptLanguage = acceptLanguage_example # String |  (optional)
referer = referer_example # String |  (optional)
xForEmbed = true # Boolean |  (optional)
xForEmbedCode = true # Boolean |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)
xUserAgent = xUserAgent_example # String |  (optional)
xVisitCount = 56 # Integer |  (optional)
xWithEmbedCode = true # Boolean |  (optional)

try: 
    # show frontend_bot
    api_response = api_instance.frontend_bot_show(id, slug, organisation=organisation, acceptLanguage=acceptLanguage, referer=referer, xForEmbed=xForEmbed, xForEmbedCode=xForEmbedCode, xForwardedFor=xForwardedFor, xUserAgent=xUserAgent, xVisitCount=xVisitCount, xWithEmbedCode=xWithEmbedCode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FrontendBotApi->frontendBotShow: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot id or slug
Required
slug*
String
Bot slug
Required
Header parameters
Name Description
Accept-Language
String
Referer
String
X-For-Embed
Boolean
X-For-Embed-Code
Boolean
X-Forwarded-For
String
X-User-Agent
String
X-Visit-Count
Integer
X-With-Embed-Code
Boolean
Query parameters
Name Description
organisation
String
Organisation id or slug

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 404 - Not Found

Status: 530 - Quota exceeded (free plan)

Status: 531 - Quota exceeded (paid plan)

Status: 532 - Trigger condition not passed


frontendBotShow1

show frontend_bot

Retrieve questionnaire with given organisation id/slug and bot id/slug.


/0.0.1/frontend/bots/by_domain/{id}

Usage and SDK Samples

curl -X GET "https://api.quriobot.com/0.0.1/frontend/bots/by_domain/{id}?organisation=&slug="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendBotApi;

import java.io.File;
import java.util.*;

public class FrontendBotApiExample {

    public static void main(String[] args) {
        
        FrontendBotApi apiInstance = new FrontendBotApi();
        String id = id_example; // String | Bot id or slug
        String organisation = organisation_example; // String | Organisation id or slug
        String slug = slug_example; // String | Bot slug
        String acceptLanguage = acceptLanguage_example; // String | 
        String referer = referer_example; // String | 
        Boolean xForEmbed = true; // Boolean | 
        Boolean xForEmbedCode = true; // Boolean | 
        String xForwardedFor = xForwardedFor_example; // String | 
        String xUserAgent = xUserAgent_example; // String | 
        Integer xVisitCount = 56; // Integer | 
        Boolean xWithEmbedCode = true; // Boolean | 
        try {
            Bot result = apiInstance.frontendBotShow1(id, organisation, slug, acceptLanguage, referer, xForEmbed, xForEmbedCode, xForwardedFor, xUserAgent, xVisitCount, xWithEmbedCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendBotApi#frontendBotShow1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendBotApi;

public class FrontendBotApiExample {

    public static void main(String[] args) {
        FrontendBotApi apiInstance = new FrontendBotApi();
        String id = id_example; // String | Bot id or slug
        String organisation = organisation_example; // String | Organisation id or slug
        String slug = slug_example; // String | Bot slug
        String acceptLanguage = acceptLanguage_example; // String | 
        String referer = referer_example; // String | 
        Boolean xForEmbed = true; // Boolean | 
        Boolean xForEmbedCode = true; // Boolean | 
        String xForwardedFor = xForwardedFor_example; // String | 
        String xUserAgent = xUserAgent_example; // String | 
        Integer xVisitCount = 56; // Integer | 
        Boolean xWithEmbedCode = true; // Boolean | 
        try {
            Bot result = apiInstance.frontendBotShow1(id, organisation, slug, acceptLanguage, referer, xForEmbed, xForEmbedCode, xForwardedFor, xUserAgent, xVisitCount, xWithEmbedCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendBotApi#frontendBotShow1");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Bot id or slug
String *organisation = organisation_example; // Organisation id or slug (optional)
String *slug = slug_example; // Bot slug (optional)
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *referer = referer_example; //  (optional)
Boolean *xForEmbed = true; //  (optional)
Boolean *xForEmbedCode = true; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)
String *xUserAgent = xUserAgent_example; //  (optional)
Integer *xVisitCount = 56; //  (optional)
Boolean *xWithEmbedCode = true; //  (optional)

FrontendBotApi *apiInstance = [[FrontendBotApi alloc] init];

// show frontend_bot
[apiInstance frontendBotShow1With:id
    organisation:organisation
    slug:slug
    acceptLanguage:acceptLanguage
    referer:referer
    xForEmbed:xForEmbed
    xForEmbedCode:xForEmbedCode
    xForwardedFor:xForwardedFor
    xUserAgent:xUserAgent
    xVisitCount:xVisitCount
    xWithEmbedCode:xWithEmbedCode
              completionHandler: ^(Bot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendBotApi()

var id = id_example; // {String} Bot id or slug

var opts = { 
  'organisation': organisation_example, // {String} Organisation id or slug
  'slug': slug_example, // {String} Bot slug
  'acceptLanguage': acceptLanguage_example, // {String} 
  'referer': referer_example, // {String} 
  'xForEmbed': true, // {Boolean} 
  'xForEmbedCode': true, // {Boolean} 
  'xForwardedFor': xForwardedFor_example, // {String} 
  'xUserAgent': xUserAgent_example, // {String} 
  'xVisitCount': 56, // {Integer} 
  'xWithEmbedCode': true // {Boolean} 
};
api.frontendBotShow1(id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendBotShow1Example
    {
        public void main()
        {
            
            var apiInstance = new FrontendBotApi();
            var id = id_example;  // String | Bot id or slug
            var organisation = organisation_example;  // String | Organisation id or slug (optional) 
            var slug = slug_example;  // String | Bot slug (optional) 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var referer = referer_example;  // String |  (optional) 
            var xForEmbed = true;  // Boolean |  (optional) 
            var xForEmbedCode = true;  // Boolean |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 
            var xUserAgent = xUserAgent_example;  // String |  (optional) 
            var xVisitCount = 56;  // Integer |  (optional) 
            var xWithEmbedCode = true;  // Boolean |  (optional) 

            try
            {
                // show frontend_bot
                Bot result = apiInstance.frontendBotShow1(id, organisation, slug, acceptLanguage, referer, xForEmbed, xForEmbedCode, xForwardedFor, xUserAgent, xVisitCount, xWithEmbedCode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendBotApi.frontendBotShow1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendBotApi();
$id = id_example; // String | Bot id or slug
$organisation = organisation_example; // String | Organisation id or slug
$slug = slug_example; // String | Bot slug
$acceptLanguage = acceptLanguage_example; // String | 
$referer = referer_example; // String | 
$xForEmbed = true; // Boolean | 
$xForEmbedCode = true; // Boolean | 
$xForwardedFor = xForwardedFor_example; // String | 
$xUserAgent = xUserAgent_example; // String | 
$xVisitCount = 56; // Integer | 
$xWithEmbedCode = true; // Boolean | 

try {
    $result = $api_instance->frontendBotShow1($id, $organisation, $slug, $acceptLanguage, $referer, $xForEmbed, $xForEmbedCode, $xForwardedFor, $xUserAgent, $xVisitCount, $xWithEmbedCode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FrontendBotApi->frontendBotShow1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendBotApi;

my $api_instance = WWW::SwaggerClient::FrontendBotApi->new();
my $id = id_example; # String | Bot id or slug
my $organisation = organisation_example; # String | Organisation id or slug
my $slug = slug_example; # String | Bot slug
my $acceptLanguage = acceptLanguage_example; # String | 
my $referer = referer_example; # String | 
my $xForEmbed = true; # Boolean | 
my $xForEmbedCode = true; # Boolean | 
my $xForwardedFor = xForwardedFor_example; # String | 
my $xUserAgent = xUserAgent_example; # String | 
my $xVisitCount = 56; # Integer | 
my $xWithEmbedCode = true; # Boolean | 

eval { 
    my $result = $api_instance->frontendBotShow1(id => $id, organisation => $organisation, slug => $slug, acceptLanguage => $acceptLanguage, referer => $referer, xForEmbed => $xForEmbed, xForEmbedCode => $xForEmbedCode, xForwardedFor => $xForwardedFor, xUserAgent => $xUserAgent, xVisitCount => $xVisitCount, xWithEmbedCode => $xWithEmbedCode);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FrontendBotApi->frontendBotShow1: $@\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.FrontendBotApi()
id = id_example # String | Bot id or slug
organisation = organisation_example # String | Organisation id or slug (optional)
slug = slug_example # String | Bot slug (optional)
acceptLanguage = acceptLanguage_example # String |  (optional)
referer = referer_example # String |  (optional)
xForEmbed = true # Boolean |  (optional)
xForEmbedCode = true # Boolean |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)
xUserAgent = xUserAgent_example # String |  (optional)
xVisitCount = 56 # Integer |  (optional)
xWithEmbedCode = true # Boolean |  (optional)

try: 
    # show frontend_bot
    api_response = api_instance.frontend_bot_show1(id, organisation=organisation, slug=slug, acceptLanguage=acceptLanguage, referer=referer, xForEmbed=xForEmbed, xForEmbedCode=xForEmbedCode, xForwardedFor=xForwardedFor, xUserAgent=xUserAgent, xVisitCount=xVisitCount, xWithEmbedCode=xWithEmbedCode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FrontendBotApi->frontendBotShow1: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot id or slug
Required
Header parameters
Name Description
Accept-Language
String
Referer
String
X-For-Embed
Boolean
X-For-Embed-Code
Boolean
X-Forwarded-For
String
X-User-Agent
String
X-Visit-Count
Integer
X-With-Embed-Code
Boolean
Query parameters
Name Description
organisation
String
Organisation id or slug
slug
String
Bot slug

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 404 - Not Found

Status: 530 - Quota exceeded (free plan)

Status: 531 - Quota exceeded (paid plan)

Status: 532 - Trigger condition not passed


frontendBotShow2

show frontend_bot

Retrieve questionnaire with given organisation id/slug and bot id/slug.


/0.0.1/frontend/bots/{organisation}/{id}

Usage and SDK Samples

curl -X GET "https://api.quriobot.com/0.0.1/frontend/bots/{organisation}/{id}?slug="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendBotApi;

import java.io.File;
import java.util.*;

public class FrontendBotApiExample {

    public static void main(String[] args) {
        
        FrontendBotApi apiInstance = new FrontendBotApi();
        String id = id_example; // String | Bot id or slug
        String organisation = organisation_example; // String | Organisation id or slug
        String slug = slug_example; // String | Bot slug
        String acceptLanguage = acceptLanguage_example; // String | 
        String referer = referer_example; // String | 
        Boolean xForEmbed = true; // Boolean | 
        Boolean xForEmbedCode = true; // Boolean | 
        String xForwardedFor = xForwardedFor_example; // String | 
        String xUserAgent = xUserAgent_example; // String | 
        Integer xVisitCount = 56; // Integer | 
        Boolean xWithEmbedCode = true; // Boolean | 
        try {
            Bot result = apiInstance.frontendBotShow2(id, organisation, slug, acceptLanguage, referer, xForEmbed, xForEmbedCode, xForwardedFor, xUserAgent, xVisitCount, xWithEmbedCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendBotApi#frontendBotShow2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendBotApi;

public class FrontendBotApiExample {

    public static void main(String[] args) {
        FrontendBotApi apiInstance = new FrontendBotApi();
        String id = id_example; // String | Bot id or slug
        String organisation = organisation_example; // String | Organisation id or slug
        String slug = slug_example; // String | Bot slug
        String acceptLanguage = acceptLanguage_example; // String | 
        String referer = referer_example; // String | 
        Boolean xForEmbed = true; // Boolean | 
        Boolean xForEmbedCode = true; // Boolean | 
        String xForwardedFor = xForwardedFor_example; // String | 
        String xUserAgent = xUserAgent_example; // String | 
        Integer xVisitCount = 56; // Integer | 
        Boolean xWithEmbedCode = true; // Boolean | 
        try {
            Bot result = apiInstance.frontendBotShow2(id, organisation, slug, acceptLanguage, referer, xForEmbed, xForEmbedCode, xForwardedFor, xUserAgent, xVisitCount, xWithEmbedCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendBotApi#frontendBotShow2");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Bot id or slug
String *organisation = organisation_example; // Organisation id or slug
String *slug = slug_example; // Bot slug (optional)
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *referer = referer_example; //  (optional)
Boolean *xForEmbed = true; //  (optional)
Boolean *xForEmbedCode = true; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)
String *xUserAgent = xUserAgent_example; //  (optional)
Integer *xVisitCount = 56; //  (optional)
Boolean *xWithEmbedCode = true; //  (optional)

FrontendBotApi *apiInstance = [[FrontendBotApi alloc] init];

// show frontend_bot
[apiInstance frontendBotShow2With:id
    organisation:organisation
    slug:slug
    acceptLanguage:acceptLanguage
    referer:referer
    xForEmbed:xForEmbed
    xForEmbedCode:xForEmbedCode
    xForwardedFor:xForwardedFor
    xUserAgent:xUserAgent
    xVisitCount:xVisitCount
    xWithEmbedCode:xWithEmbedCode
              completionHandler: ^(Bot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendBotApi()

var id = id_example; // {String} Bot id or slug

var organisation = organisation_example; // {String} Organisation id or slug

var opts = { 
  'slug': slug_example, // {String} Bot slug
  'acceptLanguage': acceptLanguage_example, // {String} 
  'referer': referer_example, // {String} 
  'xForEmbed': true, // {Boolean} 
  'xForEmbedCode': true, // {Boolean} 
  'xForwardedFor': xForwardedFor_example, // {String} 
  'xUserAgent': xUserAgent_example, // {String} 
  'xVisitCount': 56, // {Integer} 
  'xWithEmbedCode': true // {Boolean} 
};
api.frontendBotShow2(id, organisation, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendBotShow2Example
    {
        public void main()
        {
            
            var apiInstance = new FrontendBotApi();
            var id = id_example;  // String | Bot id or slug
            var organisation = organisation_example;  // String | Organisation id or slug
            var slug = slug_example;  // String | Bot slug (optional) 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var referer = referer_example;  // String |  (optional) 
            var xForEmbed = true;  // Boolean |  (optional) 
            var xForEmbedCode = true;  // Boolean |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 
            var xUserAgent = xUserAgent_example;  // String |  (optional) 
            var xVisitCount = 56;  // Integer |  (optional) 
            var xWithEmbedCode = true;  // Boolean |  (optional) 

            try
            {
                // show frontend_bot
                Bot result = apiInstance.frontendBotShow2(id, organisation, slug, acceptLanguage, referer, xForEmbed, xForEmbedCode, xForwardedFor, xUserAgent, xVisitCount, xWithEmbedCode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendBotApi.frontendBotShow2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendBotApi();
$id = id_example; // String | Bot id or slug
$organisation = organisation_example; // String | Organisation id or slug
$slug = slug_example; // String | Bot slug
$acceptLanguage = acceptLanguage_example; // String | 
$referer = referer_example; // String | 
$xForEmbed = true; // Boolean | 
$xForEmbedCode = true; // Boolean | 
$xForwardedFor = xForwardedFor_example; // String | 
$xUserAgent = xUserAgent_example; // String | 
$xVisitCount = 56; // Integer | 
$xWithEmbedCode = true; // Boolean | 

try {
    $result = $api_instance->frontendBotShow2($id, $organisation, $slug, $acceptLanguage, $referer, $xForEmbed, $xForEmbedCode, $xForwardedFor, $xUserAgent, $xVisitCount, $xWithEmbedCode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FrontendBotApi->frontendBotShow2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendBotApi;

my $api_instance = WWW::SwaggerClient::FrontendBotApi->new();
my $id = id_example; # String | Bot id or slug
my $organisation = organisation_example; # String | Organisation id or slug
my $slug = slug_example; # String | Bot slug
my $acceptLanguage = acceptLanguage_example; # String | 
my $referer = referer_example; # String | 
my $xForEmbed = true; # Boolean | 
my $xForEmbedCode = true; # Boolean | 
my $xForwardedFor = xForwardedFor_example; # String | 
my $xUserAgent = xUserAgent_example; # String | 
my $xVisitCount = 56; # Integer | 
my $xWithEmbedCode = true; # Boolean | 

eval { 
    my $result = $api_instance->frontendBotShow2(id => $id, organisation => $organisation, slug => $slug, acceptLanguage => $acceptLanguage, referer => $referer, xForEmbed => $xForEmbed, xForEmbedCode => $xForEmbedCode, xForwardedFor => $xForwardedFor, xUserAgent => $xUserAgent, xVisitCount => $xVisitCount, xWithEmbedCode => $xWithEmbedCode);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FrontendBotApi->frontendBotShow2: $@\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.FrontendBotApi()
id = id_example # String | Bot id or slug
organisation = organisation_example # String | Organisation id or slug
slug = slug_example # String | Bot slug (optional)
acceptLanguage = acceptLanguage_example # String |  (optional)
referer = referer_example # String |  (optional)
xForEmbed = true # Boolean |  (optional)
xForEmbedCode = true # Boolean |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)
xUserAgent = xUserAgent_example # String |  (optional)
xVisitCount = 56 # Integer |  (optional)
xWithEmbedCode = true # Boolean |  (optional)

try: 
    # show frontend_bot
    api_response = api_instance.frontend_bot_show2(id, organisation, slug=slug, acceptLanguage=acceptLanguage, referer=referer, xForEmbed=xForEmbed, xForEmbedCode=xForEmbedCode, xForwardedFor=xForwardedFor, xUserAgent=xUserAgent, xVisitCount=xVisitCount, xWithEmbedCode=xWithEmbedCode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FrontendBotApi->frontendBotShow2: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot id or slug
Required
organisation*
String
Organisation id or slug
Required
Header parameters
Name Description
Accept-Language
String
Referer
String
X-For-Embed
Boolean
X-For-Embed-Code
Boolean
X-Forwarded-For
String
X-User-Agent
String
X-Visit-Count
Integer
X-With-Embed-Code
Boolean
Query parameters
Name Description
slug
String
Bot slug

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 404 - Not Found

Status: 530 - Quota exceeded (free plan)

Status: 531 - Quota exceeded (paid plan)

Status: 532 - Trigger condition not passed


frontendBotStart

start frontend_bot

Start the bot with given organisation id/slug and bot id/slug.


/0.0.1/frontend/bots/{organisation}/{id}/start

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/frontend/bots/{organisation}/{id}/start"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendBotApi;

import java.io.File;
import java.util.*;

public class FrontendBotApiExample {

    public static void main(String[] args) {
        
        FrontendBotApi apiInstance = new FrontendBotApi();
        String id = id_example; // String | Bot id or slug
        String organisation = organisation_example; // String | Organisation id or slug
        BotStartPayload payload = ; // BotStartPayload | Bot start payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String referer = referer_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        String xUserAgent = xUserAgent_example; // String | 
        try {
            Bot_responseReference result = apiInstance.frontendBotStart(id, organisation, payload, acceptLanguage, referer, xForwardedFor, xUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendBotApi#frontendBotStart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendBotApi;

public class FrontendBotApiExample {

    public static void main(String[] args) {
        FrontendBotApi apiInstance = new FrontendBotApi();
        String id = id_example; // String | Bot id or slug
        String organisation = organisation_example; // String | Organisation id or slug
        BotStartPayload payload = ; // BotStartPayload | Bot start payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String referer = referer_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        String xUserAgent = xUserAgent_example; // String | 
        try {
            Bot_responseReference result = apiInstance.frontendBotStart(id, organisation, payload, acceptLanguage, referer, xForwardedFor, xUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendBotApi#frontendBotStart");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Bot id or slug
String *organisation = organisation_example; // Organisation id or slug
BotStartPayload *payload = ; // Bot start payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *referer = referer_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)
String *xUserAgent = xUserAgent_example; //  (optional)

FrontendBotApi *apiInstance = [[FrontendBotApi alloc] init];

// start frontend_bot
[apiInstance frontendBotStartWith:id
    organisation:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    referer:referer
    xForwardedFor:xForwardedFor
    xUserAgent:xUserAgent
              completionHandler: ^(Bot_responseReference output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendBotApi()

var id = id_example; // {String} Bot id or slug

var organisation = organisation_example; // {String} Organisation id or slug

var payload = ; // {BotStartPayload} Bot start payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'referer': referer_example, // {String} 
  'xForwardedFor': xForwardedFor_example, // {String} 
  'xUserAgent': xUserAgent_example // {String} 
};
api.frontendBotStart(id, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendBotStartExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendBotApi();
            var id = id_example;  // String | Bot id or slug
            var organisation = organisation_example;  // String | Organisation id or slug
            var payload = new BotStartPayload(); // BotStartPayload | Bot start payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var referer = referer_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 
            var xUserAgent = xUserAgent_example;  // String |  (optional) 

            try
            {
                // start frontend_bot
                Bot_responseReference result = apiInstance.frontendBotStart(id, organisation, payload, acceptLanguage, referer, xForwardedFor, xUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendBotApi.frontendBotStart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendBotApi();
$id = id_example; // String | Bot id or slug
$organisation = organisation_example; // String | Organisation id or slug
$payload = ; // BotStartPayload | Bot start payload
$acceptLanguage = acceptLanguage_example; // String | 
$referer = referer_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 
$xUserAgent = xUserAgent_example; // String | 

try {
    $result = $api_instance->frontendBotStart($id, $organisation, $payload, $acceptLanguage, $referer, $xForwardedFor, $xUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FrontendBotApi->frontendBotStart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendBotApi;

my $api_instance = WWW::SwaggerClient::FrontendBotApi->new();
my $id = id_example; # String | Bot id or slug
my $organisation = organisation_example; # String | Organisation id or slug
my $payload = WWW::SwaggerClient::Object::BotStartPayload->new(); # BotStartPayload | Bot start payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $referer = referer_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 
my $xUserAgent = xUserAgent_example; # String | 

eval { 
    my $result = $api_instance->frontendBotStart(id => $id, organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, referer => $referer, xForwardedFor => $xForwardedFor, xUserAgent => $xUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FrontendBotApi->frontendBotStart: $@\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.FrontendBotApi()
id = id_example # String | Bot id or slug
organisation = organisation_example # String | Organisation id or slug
payload =  # BotStartPayload | Bot start payload
acceptLanguage = acceptLanguage_example # String |  (optional)
referer = referer_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)
xUserAgent = xUserAgent_example # String |  (optional)

try: 
    # start frontend_bot
    api_response = api_instance.frontend_bot_start(id, organisation, payload, acceptLanguage=acceptLanguage, referer=referer, xForwardedFor=xForwardedFor, xUserAgent=xUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FrontendBotApi->frontendBotStart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Bot id or slug
Required
organisation*
String
Organisation id or slug
Required
Header parameters
Name Description
Accept-Language
String
Referer
String
X-Forwarded-For
String
X-User-Agent
String
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 404 - Not Found


FrontendChat

frontendChatAnswerStep

answer_step frontend_chat

Answer Facebook chat step


/0.0.1/frontend/chats/{channel}/step/{chatID}/{id}/answer

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/frontend/chats/{channel}/step/{chatID}/{id}/answer"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendChatApi;

import java.io.File;
import java.util.*;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        
        FrontendChatApi apiInstance = new FrontendChatApi();
        String channel = channel_example; // String | Channel
        String chatID = chatID_example; // String | Chat id
        String id = id_example; // String | Bot step id
        BotChatStepAnswerPayload payload = ; // BotChatStepAnswerPayload | Bot chat step answer payload
        String userAgent = userAgent_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            apiInstance.frontendChatAnswerStep(channel, chatID, id, payload, userAgent, xForwardedFor);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatAnswerStep");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendChatApi;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        FrontendChatApi apiInstance = new FrontendChatApi();
        String channel = channel_example; // String | Channel
        String chatID = chatID_example; // String | Chat id
        String id = id_example; // String | Bot step id
        BotChatStepAnswerPayload payload = ; // BotChatStepAnswerPayload | Bot chat step answer payload
        String userAgent = userAgent_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            apiInstance.frontendChatAnswerStep(channel, chatID, id, payload, userAgent, xForwardedFor);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatAnswerStep");
            e.printStackTrace();
        }
    }
}
String *channel = channel_example; // Channel
String *chatID = chatID_example; // Chat id
String *id = id_example; // Bot step id
BotChatStepAnswerPayload *payload = ; // Bot chat step answer payload
String *userAgent = userAgent_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

FrontendChatApi *apiInstance = [[FrontendChatApi alloc] init];

// answer_step frontend_chat
[apiInstance frontendChatAnswerStepWith:channel
    chatID:chatID
    id:id
    payload:payload
    userAgent:userAgent
    xForwardedFor:xForwardedFor
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendChatApi()

var channel = channel_example; // {String} Channel

var chatID = chatID_example; // {String} Chat id

var id = id_example; // {String} Bot step id

var payload = ; // {BotChatStepAnswerPayload} Bot chat step answer payload

var opts = { 
  'userAgent': userAgent_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.frontendChatAnswerStep(channel, chatID, id, payload, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendChatAnswerStepExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendChatApi();
            var channel = channel_example;  // String | Channel
            var chatID = chatID_example;  // String | Chat id
            var id = id_example;  // String | Bot step id
            var payload = new BotChatStepAnswerPayload(); // BotChatStepAnswerPayload | Bot chat step answer payload
            var userAgent = userAgent_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // answer_step frontend_chat
                apiInstance.frontendChatAnswerStep(channel, chatID, id, payload, userAgent, xForwardedFor);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendChatApi.frontendChatAnswerStep: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendChatApi();
$channel = channel_example; // String | Channel
$chatID = chatID_example; // String | Chat id
$id = id_example; // String | Bot step id
$payload = ; // BotChatStepAnswerPayload | Bot chat step answer payload
$userAgent = userAgent_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $api_instance->frontendChatAnswerStep($channel, $chatID, $id, $payload, $userAgent, $xForwardedFor);
} catch (Exception $e) {
    echo 'Exception when calling FrontendChatApi->frontendChatAnswerStep: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendChatApi;

my $api_instance = WWW::SwaggerClient::FrontendChatApi->new();
my $channel = channel_example; # String | Channel
my $chatID = chatID_example; # String | Chat id
my $id = id_example; # String | Bot step id
my $payload = WWW::SwaggerClient::Object::BotChatStepAnswerPayload->new(); # BotChatStepAnswerPayload | Bot chat step answer payload
my $userAgent = userAgent_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    $api_instance->frontendChatAnswerStep(channel => $channel, chatID => $chatID, id => $id, payload => $payload, userAgent => $userAgent, xForwardedFor => $xForwardedFor);
};
if ($@) {
    warn "Exception when calling FrontendChatApi->frontendChatAnswerStep: $@\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.FrontendChatApi()
channel = channel_example # String | Channel
chatID = chatID_example # String | Chat id
id = id_example # String | Bot step id
payload =  # BotChatStepAnswerPayload | Bot chat step answer payload
userAgent = userAgent_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # answer_step frontend_chat
    api_instance.frontend_chat_answer_step(channel, chatID, id, payload, userAgent=userAgent, xForwardedFor=xForwardedFor)
except ApiException as e:
    print("Exception when calling FrontendChatApi->frontendChatAnswerStep: %s\n" % e)

Parameters

Path parameters
Name Description
channel*
String
Channel
Required
chatID*
String
Chat id
Required
id*
String
Bot step id
Required
Header parameters
Name Description
User-Agent
String
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 404 - Not Found


frontendChatCreateStepTextFeedback

create_step_text_feedback frontend_chat

Create step text feedback


/0.0.1/frontend/chats/{channel}/step/{chatID}/{id}/{textID}/feedback

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/frontend/chats/{channel}/step/{chatID}/{id}/{textID}/feedback"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendChatApi;

import java.io.File;
import java.util.*;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        
        FrontendChatApi apiInstance = new FrontendChatApi();
        String channel = channel_example; // String | Channel
        String chatID = chatID_example; // String | Chat id
        String id = id_example; // String | Bot step id
        String textID = textID_example; // String | Bot step chat text id
        BotChatStepTextFeedbackPayload payload = ; // BotChatStepTextFeedbackPayload | Bot chat step text feedback payload
        try {
            apiInstance.frontendChatCreateStepTextFeedback(channel, chatID, id, textID, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatCreateStepTextFeedback");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendChatApi;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        FrontendChatApi apiInstance = new FrontendChatApi();
        String channel = channel_example; // String | Channel
        String chatID = chatID_example; // String | Chat id
        String id = id_example; // String | Bot step id
        String textID = textID_example; // String | Bot step chat text id
        BotChatStepTextFeedbackPayload payload = ; // BotChatStepTextFeedbackPayload | Bot chat step text feedback payload
        try {
            apiInstance.frontendChatCreateStepTextFeedback(channel, chatID, id, textID, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatCreateStepTextFeedback");
            e.printStackTrace();
        }
    }
}
String *channel = channel_example; // Channel
String *chatID = chatID_example; // Chat id
String *id = id_example; // Bot step id
String *textID = textID_example; // Bot step chat text id
BotChatStepTextFeedbackPayload *payload = ; // Bot chat step text feedback payload

FrontendChatApi *apiInstance = [[FrontendChatApi alloc] init];

// create_step_text_feedback frontend_chat
[apiInstance frontendChatCreateStepTextFeedbackWith:channel
    chatID:chatID
    id:id
    textID:textID
    payload:payload
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendChatApi()

var channel = channel_example; // {String} Channel

var chatID = chatID_example; // {String} Chat id

var id = id_example; // {String} Bot step id

var textID = textID_example; // {String} Bot step chat text id

var payload = ; // {BotChatStepTextFeedbackPayload} Bot chat step text feedback payload

api.frontendChatCreateStepTextFeedback(channel, chatID, id, textID, payload).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendChatCreateStepTextFeedbackExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendChatApi();
            var channel = channel_example;  // String | Channel
            var chatID = chatID_example;  // String | Chat id
            var id = id_example;  // String | Bot step id
            var textID = textID_example;  // String | Bot step chat text id
            var payload = new BotChatStepTextFeedbackPayload(); // BotChatStepTextFeedbackPayload | Bot chat step text feedback payload

            try
            {
                // create_step_text_feedback frontend_chat
                apiInstance.frontendChatCreateStepTextFeedback(channel, chatID, id, textID, payload);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendChatApi.frontendChatCreateStepTextFeedback: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendChatApi();
$channel = channel_example; // String | Channel
$chatID = chatID_example; // String | Chat id
$id = id_example; // String | Bot step id
$textID = textID_example; // String | Bot step chat text id
$payload = ; // BotChatStepTextFeedbackPayload | Bot chat step text feedback payload

try {
    $api_instance->frontendChatCreateStepTextFeedback($channel, $chatID, $id, $textID, $payload);
} catch (Exception $e) {
    echo 'Exception when calling FrontendChatApi->frontendChatCreateStepTextFeedback: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendChatApi;

my $api_instance = WWW::SwaggerClient::FrontendChatApi->new();
my $channel = channel_example; # String | Channel
my $chatID = chatID_example; # String | Chat id
my $id = id_example; # String | Bot step id
my $textID = textID_example; # String | Bot step chat text id
my $payload = WWW::SwaggerClient::Object::BotChatStepTextFeedbackPayload->new(); # BotChatStepTextFeedbackPayload | Bot chat step text feedback payload

eval { 
    $api_instance->frontendChatCreateStepTextFeedback(channel => $channel, chatID => $chatID, id => $id, textID => $textID, payload => $payload);
};
if ($@) {
    warn "Exception when calling FrontendChatApi->frontendChatCreateStepTextFeedback: $@\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.FrontendChatApi()
channel = channel_example # String | Channel
chatID = chatID_example # String | Chat id
id = id_example # String | Bot step id
textID = textID_example # String | Bot step chat text id
payload =  # BotChatStepTextFeedbackPayload | Bot chat step text feedback payload

try: 
    # create_step_text_feedback frontend_chat
    api_instance.frontend_chat_create_step_text_feedback(channel, chatID, id, textID, payload)
except ApiException as e:
    print("Exception when calling FrontendChatApi->frontendChatCreateStepTextFeedback: %s\n" % e)

Parameters

Path parameters
Name Description
channel*
String
Channel
Required
chatID*
String
Chat id
Required
id*
String
Bot step id
Required
textID*
String
Bot step chat text id
Required
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 404 - Not Found


frontendChatDialog360Event

dialog360_event frontend_chat

Receive Dialog360 event webhook.


/0.0.1/frontend/chats/dialog360/events/{channelID}/{token}

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/frontend/chats/dialog360/events/{channelID}/{token}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendChatApi;

import java.io.File;
import java.util.*;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        
        FrontendChatApi apiInstance = new FrontendChatApi();
        String channelID = channelID_example; // String | Channel id
        String token = token_example; // String | Token
        try {
            apiInstance.frontendChatDialog360Event(channelID, token);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatDialog360Event");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendChatApi;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        FrontendChatApi apiInstance = new FrontendChatApi();
        String channelID = channelID_example; // String | Channel id
        String token = token_example; // String | Token
        try {
            apiInstance.frontendChatDialog360Event(channelID, token);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatDialog360Event");
            e.printStackTrace();
        }
    }
}
String *channelID = channelID_example; // Channel id
String *token = token_example; // Token

FrontendChatApi *apiInstance = [[FrontendChatApi alloc] init];

// dialog360_event frontend_chat
[apiInstance frontendChatDialog360EventWith:channelID
    token:token
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendChatApi()

var channelID = channelID_example; // {String} Channel id

var token = token_example; // {String} Token

api.frontendChatDialog360Event(channelID, token).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendChatDialog360EventExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendChatApi();
            var channelID = channelID_example;  // String | Channel id
            var token = token_example;  // String | Token

            try
            {
                // dialog360_event frontend_chat
                apiInstance.frontendChatDialog360Event(channelID, token);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendChatApi.frontendChatDialog360Event: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendChatApi();
$channelID = channelID_example; // String | Channel id
$token = token_example; // String | Token

try {
    $api_instance->frontendChatDialog360Event($channelID, $token);
} catch (Exception $e) {
    echo 'Exception when calling FrontendChatApi->frontendChatDialog360Event: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendChatApi;

my $api_instance = WWW::SwaggerClient::FrontendChatApi->new();
my $channelID = channelID_example; # String | Channel id
my $token = token_example; # String | Token

eval { 
    $api_instance->frontendChatDialog360Event(channelID => $channelID, token => $token);
};
if ($@) {
    warn "Exception when calling FrontendChatApi->frontendChatDialog360Event: $@\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.FrontendChatApi()
channelID = channelID_example # String | Channel id
token = token_example # String | Token

try: 
    # dialog360_event frontend_chat
    api_instance.frontend_chat_dialog360_event(channelID, token)
except ApiException as e:
    print("Exception when calling FrontendChatApi->frontendChatDialog360Event: %s\n" % e)

Parameters

Path parameters
Name Description
channelID*
String
Channel id
Required
token*
String
Token
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 404 - Not Found


frontendChatFbMessage

fb_message frontend_chat

Receive fb message events webhook.


/0.0.1/frontend/chats/fb/message

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/frontend/chats/fb/message"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendChatApi;

import java.io.File;
import java.util.*;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        
        FrontendChatApi apiInstance = new FrontendChatApi();
        try {
            apiInstance.frontendChatFbMessage();
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatFbMessage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendChatApi;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        FrontendChatApi apiInstance = new FrontendChatApi();
        try {
            apiInstance.frontendChatFbMessage();
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatFbMessage");
            e.printStackTrace();
        }
    }
}

FrontendChatApi *apiInstance = [[FrontendChatApi alloc] init];

// fb_message frontend_chat
[apiInstance frontendChatFbMessageWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendChatApi()
api.frontendChatFbMessage().then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendChatFbMessageExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendChatApi();

            try
            {
                // fb_message frontend_chat
                apiInstance.frontendChatFbMessage();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendChatApi.frontendChatFbMessage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendChatApi();

try {
    $api_instance->frontendChatFbMessage();
} catch (Exception $e) {
    echo 'Exception when calling FrontendChatApi->frontendChatFbMessage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendChatApi;

my $api_instance = WWW::SwaggerClient::FrontendChatApi->new();

eval { 
    $api_instance->frontendChatFbMessage();
};
if ($@) {
    warn "Exception when calling FrontendChatApi->frontendChatFbMessage: $@\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.FrontendChatApi()

try: 
    # fb_message frontend_chat
    api_instance.frontend_chat_fb_message()
except ApiException as e:
    print("Exception when calling FrontendChatApi->frontendChatFbMessage: %s\n" % e)

Parameters

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 404 - Not Found


frontendChatFbMessageVerify

fb_message_verify frontend_chat

Verify fb message events webhook.


/0.0.1/frontend/chats/fb/message

Usage and SDK Samples

curl -X GET "https://api.quriobot.com/0.0.1/frontend/chats/fb/message"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendChatApi;

import java.io.File;
import java.util.*;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        
        FrontendChatApi apiInstance = new FrontendChatApi();
        try {
            apiInstance.frontendChatFbMessageVerify();
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatFbMessageVerify");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendChatApi;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        FrontendChatApi apiInstance = new FrontendChatApi();
        try {
            apiInstance.frontendChatFbMessageVerify();
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatFbMessageVerify");
            e.printStackTrace();
        }
    }
}

FrontendChatApi *apiInstance = [[FrontendChatApi alloc] init];

// fb_message_verify frontend_chat
[apiInstance frontendChatFbMessageVerifyWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendChatApi()
api.frontendChatFbMessageVerify().then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendChatFbMessageVerifyExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendChatApi();

            try
            {
                // fb_message_verify frontend_chat
                apiInstance.frontendChatFbMessageVerify();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendChatApi.frontendChatFbMessageVerify: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendChatApi();

try {
    $api_instance->frontendChatFbMessageVerify();
} catch (Exception $e) {
    echo 'Exception when calling FrontendChatApi->frontendChatFbMessageVerify: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendChatApi;

my $api_instance = WWW::SwaggerClient::FrontendChatApi->new();

eval { 
    $api_instance->frontendChatFbMessageVerify();
};
if ($@) {
    warn "Exception when calling FrontendChatApi->frontendChatFbMessageVerify: $@\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.FrontendChatApi()

try: 
    # fb_message_verify frontend_chat
    api_instance.frontend_chat_fb_message_verify()
except ApiException as e:
    print("Exception when calling FrontendChatApi->frontendChatFbMessageVerify: %s\n" % e)

Parameters

Responses

Status: 200 - String

Status: 400 - Bad Request


frontendChatGbmEvent

gbm_event frontend_chat

Receive Google Business Messages event webhook.


/0.0.1/frontend/chats/gbm/event

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/frontend/chats/gbm/event"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendChatApi;

import java.io.File;
import java.util.*;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        
        FrontendChatApi apiInstance = new FrontendChatApi();
        try {
            apiInstance.frontendChatGbmEvent();
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatGbmEvent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendChatApi;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        FrontendChatApi apiInstance = new FrontendChatApi();
        try {
            apiInstance.frontendChatGbmEvent();
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatGbmEvent");
            e.printStackTrace();
        }
    }
}

FrontendChatApi *apiInstance = [[FrontendChatApi alloc] init];

// gbm_event frontend_chat
[apiInstance frontendChatGbmEventWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendChatApi()
api.frontendChatGbmEvent().then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendChatGbmEventExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendChatApi();

            try
            {
                // gbm_event frontend_chat
                apiInstance.frontendChatGbmEvent();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendChatApi.frontendChatGbmEvent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendChatApi();

try {
    $api_instance->frontendChatGbmEvent();
} catch (Exception $e) {
    echo 'Exception when calling FrontendChatApi->frontendChatGbmEvent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendChatApi;

my $api_instance = WWW::SwaggerClient::FrontendChatApi->new();

eval { 
    $api_instance->frontendChatGbmEvent();
};
if ($@) {
    warn "Exception when calling FrontendChatApi->frontendChatGbmEvent: $@\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.FrontendChatApi()

try: 
    # gbm_event frontend_chat
    api_instance.frontend_chat_gbm_event()
except ApiException as e:
    print("Exception when calling FrontendChatApi->frontendChatGbmEvent: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 204 - No Content

Status: 400 - Bad Request

Status: 404 - Not Found


frontendChatInstagramMessage

instagram_message frontend_chat

Receive instagram message events webhook.


/0.0.1/frontend/chats/instagram/message

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/frontend/chats/instagram/message"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendChatApi;

import java.io.File;
import java.util.*;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        
        FrontendChatApi apiInstance = new FrontendChatApi();
        try {
            apiInstance.frontendChatInstagramMessage();
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatInstagramMessage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendChatApi;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        FrontendChatApi apiInstance = new FrontendChatApi();
        try {
            apiInstance.frontendChatInstagramMessage();
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatInstagramMessage");
            e.printStackTrace();
        }
    }
}

FrontendChatApi *apiInstance = [[FrontendChatApi alloc] init];

// instagram_message frontend_chat
[apiInstance frontendChatInstagramMessageWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendChatApi()
api.frontendChatInstagramMessage().then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendChatInstagramMessageExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendChatApi();

            try
            {
                // instagram_message frontend_chat
                apiInstance.frontendChatInstagramMessage();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendChatApi.frontendChatInstagramMessage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendChatApi();

try {
    $api_instance->frontendChatInstagramMessage();
} catch (Exception $e) {
    echo 'Exception when calling FrontendChatApi->frontendChatInstagramMessage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendChatApi;

my $api_instance = WWW::SwaggerClient::FrontendChatApi->new();

eval { 
    $api_instance->frontendChatInstagramMessage();
};
if ($@) {
    warn "Exception when calling FrontendChatApi->frontendChatInstagramMessage: $@\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.FrontendChatApi()

try: 
    # instagram_message frontend_chat
    api_instance.frontend_chat_instagram_message()
except ApiException as e:
    print("Exception when calling FrontendChatApi->frontendChatInstagramMessage: %s\n" % e)

Parameters

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 404 - Not Found


frontendChatInstagramMessageVerify

instagram_message_verify frontend_chat

Verify instagram message events webhook.


/0.0.1/frontend/chats/instagram/message

Usage and SDK Samples

curl -X GET "https://api.quriobot.com/0.0.1/frontend/chats/instagram/message"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendChatApi;

import java.io.File;
import java.util.*;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        
        FrontendChatApi apiInstance = new FrontendChatApi();
        try {
            apiInstance.frontendChatInstagramMessageVerify();
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatInstagramMessageVerify");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendChatApi;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        FrontendChatApi apiInstance = new FrontendChatApi();
        try {
            apiInstance.frontendChatInstagramMessageVerify();
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatInstagramMessageVerify");
            e.printStackTrace();
        }
    }
}

FrontendChatApi *apiInstance = [[FrontendChatApi alloc] init];

// instagram_message_verify frontend_chat
[apiInstance frontendChatInstagramMessageVerifyWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendChatApi()
api.frontendChatInstagramMessageVerify().then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendChatInstagramMessageVerifyExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendChatApi();

            try
            {
                // instagram_message_verify frontend_chat
                apiInstance.frontendChatInstagramMessageVerify();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendChatApi.frontendChatInstagramMessageVerify: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendChatApi();

try {
    $api_instance->frontendChatInstagramMessageVerify();
} catch (Exception $e) {
    echo 'Exception when calling FrontendChatApi->frontendChatInstagramMessageVerify: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendChatApi;

my $api_instance = WWW::SwaggerClient::FrontendChatApi->new();

eval { 
    $api_instance->frontendChatInstagramMessageVerify();
};
if ($@) {
    warn "Exception when calling FrontendChatApi->frontendChatInstagramMessageVerify: $@\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.FrontendChatApi()

try: 
    # instagram_message_verify frontend_chat
    api_instance.frontend_chat_instagram_message_verify()
except ApiException as e:
    print("Exception when calling FrontendChatApi->frontendChatInstagramMessageVerify: %s\n" % e)

Parameters

Responses

Status: 200 - String

Status: 400 - Bad Request


frontendChatLineEvents

line_events frontend_chat

Receive line events webhook.


/0.0.1/frontend/chats/line/events/{channelID}

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/frontend/chats/line/events/{channelID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendChatApi;

import java.io.File;
import java.util.*;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        
        FrontendChatApi apiInstance = new FrontendChatApi();
        String channelID = channelID_example; // String | Channel id
        try {
            apiInstance.frontendChatLineEvents(channelID);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatLineEvents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendChatApi;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        FrontendChatApi apiInstance = new FrontendChatApi();
        String channelID = channelID_example; // String | Channel id
        try {
            apiInstance.frontendChatLineEvents(channelID);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatLineEvents");
            e.printStackTrace();
        }
    }
}
String *channelID = channelID_example; // Channel id

FrontendChatApi *apiInstance = [[FrontendChatApi alloc] init];

// line_events frontend_chat
[apiInstance frontendChatLineEventsWith:channelID
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendChatApi()

var channelID = channelID_example; // {String} Channel id

api.frontendChatLineEvents(channelID).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendChatLineEventsExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendChatApi();
            var channelID = channelID_example;  // String | Channel id

            try
            {
                // line_events frontend_chat
                apiInstance.frontendChatLineEvents(channelID);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendChatApi.frontendChatLineEvents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendChatApi();
$channelID = channelID_example; // String | Channel id

try {
    $api_instance->frontendChatLineEvents($channelID);
} catch (Exception $e) {
    echo 'Exception when calling FrontendChatApi->frontendChatLineEvents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendChatApi;

my $api_instance = WWW::SwaggerClient::FrontendChatApi->new();
my $channelID = channelID_example; # String | Channel id

eval { 
    $api_instance->frontendChatLineEvents(channelID => $channelID);
};
if ($@) {
    warn "Exception when calling FrontendChatApi->frontendChatLineEvents: $@\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.FrontendChatApi()
channelID = channelID_example # String | Channel id

try: 
    # line_events frontend_chat
    api_instance.frontend_chat_line_events(channelID)
except ApiException as e:
    print("Exception when calling FrontendChatApi->frontendChatLineEvents: %s\n" % e)

Parameters

Path parameters
Name Description
channelID*
String
Channel id
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 404 - Not Found


frontendChatMessageBirdEvents

message_bird_events frontend_chat

Receive MessageBird events webhook.


/0.0.1/frontend/chats/message_bird/events/{channelID}

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/frontend/chats/message_bird/events/{channelID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendChatApi;

import java.io.File;
import java.util.*;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        
        FrontendChatApi apiInstance = new FrontendChatApi();
        String channelID = channelID_example; // String | Channel id
        try {
            apiInstance.frontendChatMessageBirdEvents(channelID);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatMessageBirdEvents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendChatApi;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        FrontendChatApi apiInstance = new FrontendChatApi();
        String channelID = channelID_example; // String | Channel id
        try {
            apiInstance.frontendChatMessageBirdEvents(channelID);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatMessageBirdEvents");
            e.printStackTrace();
        }
    }
}
String *channelID = channelID_example; // Channel id

FrontendChatApi *apiInstance = [[FrontendChatApi alloc] init];

// message_bird_events frontend_chat
[apiInstance frontendChatMessageBirdEventsWith:channelID
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendChatApi()

var channelID = channelID_example; // {String} Channel id

api.frontendChatMessageBirdEvents(channelID).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendChatMessageBirdEventsExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendChatApi();
            var channelID = channelID_example;  // String | Channel id

            try
            {
                // message_bird_events frontend_chat
                apiInstance.frontendChatMessageBirdEvents(channelID);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendChatApi.frontendChatMessageBirdEvents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendChatApi();
$channelID = channelID_example; // String | Channel id

try {
    $api_instance->frontendChatMessageBirdEvents($channelID);
} catch (Exception $e) {
    echo 'Exception when calling FrontendChatApi->frontendChatMessageBirdEvents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendChatApi;

my $api_instance = WWW::SwaggerClient::FrontendChatApi->new();
my $channelID = channelID_example; # String | Channel id

eval { 
    $api_instance->frontendChatMessageBirdEvents(channelID => $channelID);
};
if ($@) {
    warn "Exception when calling FrontendChatApi->frontendChatMessageBirdEvents: $@\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.FrontendChatApi()
channelID = channelID_example # String | Channel id

try: 
    # message_bird_events frontend_chat
    api_instance.frontend_chat_message_bird_events(channelID)
except ApiException as e:
    print("Exception when calling FrontendChatApi->frontendChatMessageBirdEvents: %s\n" % e)

Parameters

Path parameters
Name Description
channelID*
String
Channel id
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 404 - Not Found


frontendChatMessageBirdStatus

message_bird_status frontend_chat

Receive message bird message status events webhook.


/0.0.1/frontend/chats/message_bird/events/{channelID}/status/{messageID}

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/frontend/chats/message_bird/events/{channelID}/status/{messageID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendChatApi;

import java.io.File;
import java.util.*;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        
        FrontendChatApi apiInstance = new FrontendChatApi();
        String channelID = channelID_example; // String | Channel id
        String messageID = messageID_example; // String | Message id
        try {
            apiInstance.frontendChatMessageBirdStatus(channelID, messageID);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatMessageBirdStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendChatApi;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        FrontendChatApi apiInstance = new FrontendChatApi();
        String channelID = channelID_example; // String | Channel id
        String messageID = messageID_example; // String | Message id
        try {
            apiInstance.frontendChatMessageBirdStatus(channelID, messageID);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatMessageBirdStatus");
            e.printStackTrace();
        }
    }
}
String *channelID = channelID_example; // Channel id
String *messageID = messageID_example; // Message id

FrontendChatApi *apiInstance = [[FrontendChatApi alloc] init];

// message_bird_status frontend_chat
[apiInstance frontendChatMessageBirdStatusWith:channelID
    messageID:messageID
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendChatApi()

var channelID = channelID_example; // {String} Channel id

var messageID = messageID_example; // {String} Message id

api.frontendChatMessageBirdStatus(channelID, messageID).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendChatMessageBirdStatusExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendChatApi();
            var channelID = channelID_example;  // String | Channel id
            var messageID = messageID_example;  // String | Message id

            try
            {
                // message_bird_status frontend_chat
                apiInstance.frontendChatMessageBirdStatus(channelID, messageID);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendChatApi.frontendChatMessageBirdStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendChatApi();
$channelID = channelID_example; // String | Channel id
$messageID = messageID_example; // String | Message id

try {
    $api_instance->frontendChatMessageBirdStatus($channelID, $messageID);
} catch (Exception $e) {
    echo 'Exception when calling FrontendChatApi->frontendChatMessageBirdStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendChatApi;

my $api_instance = WWW::SwaggerClient::FrontendChatApi->new();
my $channelID = channelID_example; # String | Channel id
my $messageID = messageID_example; # String | Message id

eval { 
    $api_instance->frontendChatMessageBirdStatus(channelID => $channelID, messageID => $messageID);
};
if ($@) {
    warn "Exception when calling FrontendChatApi->frontendChatMessageBirdStatus: $@\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.FrontendChatApi()
channelID = channelID_example # String | Channel id
messageID = messageID_example # String | Message id

try: 
    # message_bird_status frontend_chat
    api_instance.frontend_chat_message_bird_status(channelID, messageID)
except ApiException as e:
    print("Exception when calling FrontendChatApi->frontendChatMessageBirdStatus: %s\n" % e)

Parameters

Path parameters
Name Description
channelID*
String
Channel id
Required
messageID*
String
Message id
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 404 - Not Found


frontendChatShowStep

show_step frontend_chat

Get chat step


/0.0.1/frontend/chats/{channel}/step/{chatID}/{id}

Usage and SDK Samples

curl -X GET "https://api.quriobot.com/0.0.1/frontend/chats/{channel}/step/{chatID}/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendChatApi;

import java.io.File;
import java.util.*;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        
        FrontendChatApi apiInstance = new FrontendChatApi();
        String channel = channel_example; // String | Channel
        String chatID = chatID_example; // String | Chat id
        String id = id_example; // String | Bot step id
        try {
            Bot_chat_step result = apiInstance.frontendChatShowStep(channel, chatID, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatShowStep");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendChatApi;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        FrontendChatApi apiInstance = new FrontendChatApi();
        String channel = channel_example; // String | Channel
        String chatID = chatID_example; // String | Chat id
        String id = id_example; // String | Bot step id
        try {
            Bot_chat_step result = apiInstance.frontendChatShowStep(channel, chatID, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatShowStep");
            e.printStackTrace();
        }
    }
}
String *channel = channel_example; // Channel
String *chatID = chatID_example; // Chat id
String *id = id_example; // Bot step id

FrontendChatApi *apiInstance = [[FrontendChatApi alloc] init];

// show_step frontend_chat
[apiInstance frontendChatShowStepWith:channel
    chatID:chatID
    id:id
              completionHandler: ^(Bot_chat_step output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendChatApi()

var channel = channel_example; // {String} Channel

var chatID = chatID_example; // {String} Chat id

var id = id_example; // {String} Bot step id

api.frontendChatShowStep(channel, chatID, id).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendChatShowStepExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendChatApi();
            var channel = channel_example;  // String | Channel
            var chatID = chatID_example;  // String | Chat id
            var id = id_example;  // String | Bot step id

            try
            {
                // show_step frontend_chat
                Bot_chat_step result = apiInstance.frontendChatShowStep(channel, chatID, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendChatApi.frontendChatShowStep: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendChatApi();
$channel = channel_example; // String | Channel
$chatID = chatID_example; // String | Chat id
$id = id_example; // String | Bot step id

try {
    $result = $api_instance->frontendChatShowStep($channel, $chatID, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FrontendChatApi->frontendChatShowStep: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendChatApi;

my $api_instance = WWW::SwaggerClient::FrontendChatApi->new();
my $channel = channel_example; # String | Channel
my $chatID = chatID_example; # String | Chat id
my $id = id_example; # String | Bot step id

eval { 
    my $result = $api_instance->frontendChatShowStep(channel => $channel, chatID => $chatID, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FrontendChatApi->frontendChatShowStep: $@\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.FrontendChatApi()
channel = channel_example # String | Channel
chatID = chatID_example # String | Chat id
id = id_example # String | Bot step id

try: 
    # show_step frontend_chat
    api_response = api_instance.frontend_chat_show_step(channel, chatID, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FrontendChatApi->frontendChatShowStep: %s\n" % e)

Parameters

Path parameters
Name Description
channel*
String
Channel
Required
chatID*
String
Chat id
Required
id*
String
Bot step id
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 404 - Not Found


frontendChatShowStepOptions

show_step_options frontend_chat

Get chat step options


/0.0.1/frontend/chats/{channel}/step/{chatID}/{id}/options

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/frontend/chats/{channel}/step/{chatID}/{id}/options"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendChatApi;

import java.io.File;
import java.util.*;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        
        FrontendChatApi apiInstance = new FrontendChatApi();
        String channel = channel_example; // String | Channel
        String chatID = chatID_example; // String | Chat id
        String id = id_example; // String | Bot step id
        BotChatStepOptionCollectionPayload payload = ; // BotChatStepOptionCollectionPayload | Bot chat step option collection payload
        try {
            Bot_chat_step_option_collection result = apiInstance.frontendChatShowStepOptions(channel, chatID, id, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatShowStepOptions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendChatApi;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        FrontendChatApi apiInstance = new FrontendChatApi();
        String channel = channel_example; // String | Channel
        String chatID = chatID_example; // String | Chat id
        String id = id_example; // String | Bot step id
        BotChatStepOptionCollectionPayload payload = ; // BotChatStepOptionCollectionPayload | Bot chat step option collection payload
        try {
            Bot_chat_step_option_collection result = apiInstance.frontendChatShowStepOptions(channel, chatID, id, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatShowStepOptions");
            e.printStackTrace();
        }
    }
}
String *channel = channel_example; // Channel
String *chatID = chatID_example; // Chat id
String *id = id_example; // Bot step id
BotChatStepOptionCollectionPayload *payload = ; // Bot chat step option collection payload

FrontendChatApi *apiInstance = [[FrontendChatApi alloc] init];

// show_step_options frontend_chat
[apiInstance frontendChatShowStepOptionsWith:channel
    chatID:chatID
    id:id
    payload:payload
              completionHandler: ^(Bot_chat_step_option_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendChatApi()

var channel = channel_example; // {String} Channel

var chatID = chatID_example; // {String} Chat id

var id = id_example; // {String} Bot step id

var payload = ; // {BotChatStepOptionCollectionPayload} Bot chat step option collection payload

api.frontendChatShowStepOptions(channel, chatID, id, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendChatShowStepOptionsExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendChatApi();
            var channel = channel_example;  // String | Channel
            var chatID = chatID_example;  // String | Chat id
            var id = id_example;  // String | Bot step id
            var payload = new BotChatStepOptionCollectionPayload(); // BotChatStepOptionCollectionPayload | Bot chat step option collection payload

            try
            {
                // show_step_options frontend_chat
                Bot_chat_step_option_collection result = apiInstance.frontendChatShowStepOptions(channel, chatID, id, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendChatApi.frontendChatShowStepOptions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendChatApi();
$channel = channel_example; // String | Channel
$chatID = chatID_example; // String | Chat id
$id = id_example; // String | Bot step id
$payload = ; // BotChatStepOptionCollectionPayload | Bot chat step option collection payload

try {
    $result = $api_instance->frontendChatShowStepOptions($channel, $chatID, $id, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FrontendChatApi->frontendChatShowStepOptions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendChatApi;

my $api_instance = WWW::SwaggerClient::FrontendChatApi->new();
my $channel = channel_example; # String | Channel
my $chatID = chatID_example; # String | Chat id
my $id = id_example; # String | Bot step id
my $payload = WWW::SwaggerClient::Object::BotChatStepOptionCollectionPayload->new(); # BotChatStepOptionCollectionPayload | Bot chat step option collection payload

eval { 
    my $result = $api_instance->frontendChatShowStepOptions(channel => $channel, chatID => $chatID, id => $id, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FrontendChatApi->frontendChatShowStepOptions: $@\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.FrontendChatApi()
channel = channel_example # String | Channel
chatID = chatID_example # String | Chat id
id = id_example # String | Bot step id
payload =  # BotChatStepOptionCollectionPayload | Bot chat step option collection payload

try: 
    # show_step_options frontend_chat
    api_response = api_instance.frontend_chat_show_step_options(channel, chatID, id, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FrontendChatApi->frontendChatShowStepOptions: %s\n" % e)

Parameters

Path parameters
Name Description
channel*
String
Channel
Required
chatID*
String
Chat id
Required
id*
String
Bot step id
Required
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 404 - Not Found


frontendChatShowStepText

show_step_text frontend_chat

Get step chat text


/0.0.1/frontend/chats/{channel}/step/{chatID}/{id}/{textID}

Usage and SDK Samples

curl -X GET "https://api.quriobot.com/0.0.1/frontend/chats/{channel}/step/{chatID}/{id}/{textID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendChatApi;

import java.io.File;
import java.util.*;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        
        FrontendChatApi apiInstance = new FrontendChatApi();
        String channel = channel_example; // String | Channel
        String chatID = chatID_example; // String | Chat id
        String id = id_example; // String | Bot step id
        String textID = textID_example; // String | Bot step chat text id
        try {
            Frontend_bot_chat_text result = apiInstance.frontendChatShowStepText(channel, chatID, id, textID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatShowStepText");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendChatApi;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        FrontendChatApi apiInstance = new FrontendChatApi();
        String channel = channel_example; // String | Channel
        String chatID = chatID_example; // String | Chat id
        String id = id_example; // String | Bot step id
        String textID = textID_example; // String | Bot step chat text id
        try {
            Frontend_bot_chat_text result = apiInstance.frontendChatShowStepText(channel, chatID, id, textID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatShowStepText");
            e.printStackTrace();
        }
    }
}
String *channel = channel_example; // Channel
String *chatID = chatID_example; // Chat id
String *id = id_example; // Bot step id
String *textID = textID_example; // Bot step chat text id

FrontendChatApi *apiInstance = [[FrontendChatApi alloc] init];

// show_step_text frontend_chat
[apiInstance frontendChatShowStepTextWith:channel
    chatID:chatID
    id:id
    textID:textID
              completionHandler: ^(Frontend_bot_chat_text output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendChatApi()

var channel = channel_example; // {String} Channel

var chatID = chatID_example; // {String} Chat id

var id = id_example; // {String} Bot step id

var textID = textID_example; // {String} Bot step chat text id

api.frontendChatShowStepText(channel, chatID, id, textID).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendChatShowStepTextExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendChatApi();
            var channel = channel_example;  // String | Channel
            var chatID = chatID_example;  // String | Chat id
            var id = id_example;  // String | Bot step id
            var textID = textID_example;  // String | Bot step chat text id

            try
            {
                // show_step_text frontend_chat
                Frontend_bot_chat_text result = apiInstance.frontendChatShowStepText(channel, chatID, id, textID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendChatApi.frontendChatShowStepText: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendChatApi();
$channel = channel_example; // String | Channel
$chatID = chatID_example; // String | Chat id
$id = id_example; // String | Bot step id
$textID = textID_example; // String | Bot step chat text id

try {
    $result = $api_instance->frontendChatShowStepText($channel, $chatID, $id, $textID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FrontendChatApi->frontendChatShowStepText: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendChatApi;

my $api_instance = WWW::SwaggerClient::FrontendChatApi->new();
my $channel = channel_example; # String | Channel
my $chatID = chatID_example; # String | Chat id
my $id = id_example; # String | Bot step id
my $textID = textID_example; # String | Bot step chat text id

eval { 
    my $result = $api_instance->frontendChatShowStepText(channel => $channel, chatID => $chatID, id => $id, textID => $textID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FrontendChatApi->frontendChatShowStepText: $@\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.FrontendChatApi()
channel = channel_example # String | Channel
chatID = chatID_example # String | Chat id
id = id_example # String | Bot step id
textID = textID_example # String | Bot step chat text id

try: 
    # show_step_text frontend_chat
    api_response = api_instance.frontend_chat_show_step_text(channel, chatID, id, textID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FrontendChatApi->frontendChatShowStepText: %s\n" % e)

Parameters

Path parameters
Name Description
channel*
String
Channel
Required
chatID*
String
Chat id
Required
id*
String
Bot step id
Required
textID*
String
Bot step chat text id
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 404 - Not Found


frontendChatShowVariable

show_variable frontend_chat

Get chat variable


/0.0.1/frontend/chats/{channel}/step/{chatID}/variables/{variable}

Usage and SDK Samples

curl -X GET "https://api.quriobot.com/0.0.1/frontend/chats/{channel}/step/{chatID}/variables/{variable}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendChatApi;

import java.io.File;
import java.util.*;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        
        FrontendChatApi apiInstance = new FrontendChatApi();
        String channel = channel_example; // String | Channel
        String chatID = chatID_example; // String | Chat id
        String variable = variable_example; // String | Bot variable name
        String isStream = isStream_example; // String | Should return event stream instead of a string
        try {
            Bot_chat_variable result = apiInstance.frontendChatShowVariable(channel, chatID, variable, isStream);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatShowVariable");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendChatApi;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        FrontendChatApi apiInstance = new FrontendChatApi();
        String channel = channel_example; // String | Channel
        String chatID = chatID_example; // String | Chat id
        String variable = variable_example; // String | Bot variable name
        String isStream = isStream_example; // String | Should return event stream instead of a string
        try {
            Bot_chat_variable result = apiInstance.frontendChatShowVariable(channel, chatID, variable, isStream);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatShowVariable");
            e.printStackTrace();
        }
    }
}
String *channel = channel_example; // Channel
String *chatID = chatID_example; // Chat id
String *variable = variable_example; // Bot variable name
String *isStream = isStream_example; // Should return event stream instead of a string (optional)

FrontendChatApi *apiInstance = [[FrontendChatApi alloc] init];

// show_variable frontend_chat
[apiInstance frontendChatShowVariableWith:channel
    chatID:chatID
    variable:variable
    isStream:isStream
              completionHandler: ^(Bot_chat_variable output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendChatApi()

var channel = channel_example; // {String} Channel

var chatID = chatID_example; // {String} Chat id

var variable = variable_example; // {String} Bot variable name

var opts = { 
  'isStream': isStream_example // {String} Should return event stream instead of a string
};
api.frontendChatShowVariable(channel, chatID, variable, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendChatShowVariableExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendChatApi();
            var channel = channel_example;  // String | Channel
            var chatID = chatID_example;  // String | Chat id
            var variable = variable_example;  // String | Bot variable name
            var isStream = isStream_example;  // String | Should return event stream instead of a string (optional) 

            try
            {
                // show_variable frontend_chat
                Bot_chat_variable result = apiInstance.frontendChatShowVariable(channel, chatID, variable, isStream);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendChatApi.frontendChatShowVariable: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendChatApi();
$channel = channel_example; // String | Channel
$chatID = chatID_example; // String | Chat id
$variable = variable_example; // String | Bot variable name
$isStream = isStream_example; // String | Should return event stream instead of a string

try {
    $result = $api_instance->frontendChatShowVariable($channel, $chatID, $variable, $isStream);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FrontendChatApi->frontendChatShowVariable: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendChatApi;

my $api_instance = WWW::SwaggerClient::FrontendChatApi->new();
my $channel = channel_example; # String | Channel
my $chatID = chatID_example; # String | Chat id
my $variable = variable_example; # String | Bot variable name
my $isStream = isStream_example; # String | Should return event stream instead of a string

eval { 
    my $result = $api_instance->frontendChatShowVariable(channel => $channel, chatID => $chatID, variable => $variable, isStream => $isStream);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FrontendChatApi->frontendChatShowVariable: $@\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.FrontendChatApi()
channel = channel_example # String | Channel
chatID = chatID_example # String | Chat id
variable = variable_example # String | Bot variable name
isStream = isStream_example # String | Should return event stream instead of a string (optional)

try: 
    # show_variable frontend_chat
    api_response = api_instance.frontend_chat_show_variable(channel, chatID, variable, isStream=isStream)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FrontendChatApi->frontendChatShowVariable: %s\n" % e)

Parameters

Path parameters
Name Description
channel*
String
Channel
Required
chatID*
String
Chat id
Required
variable*
String
Bot variable name
Required
Header parameters
Name Description
Is-Stream
String
Should return event stream instead of a string

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 404 - Not Found


frontendChatTelegramEvent

telegram_event frontend_chat

Receive Telegram event webhook.


/0.0.1/frontend/chats/telegram/events/{channelID}/{token}

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/frontend/chats/telegram/events/{channelID}/{token}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendChatApi;

import java.io.File;
import java.util.*;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        
        FrontendChatApi apiInstance = new FrontendChatApi();
        String channelID = channelID_example; // String | Channel id
        String token = token_example; // String | Token
        try {
            apiInstance.frontendChatTelegramEvent(channelID, token);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatTelegramEvent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendChatApi;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        FrontendChatApi apiInstance = new FrontendChatApi();
        String channelID = channelID_example; // String | Channel id
        String token = token_example; // String | Token
        try {
            apiInstance.frontendChatTelegramEvent(channelID, token);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatTelegramEvent");
            e.printStackTrace();
        }
    }
}
String *channelID = channelID_example; // Channel id
String *token = token_example; // Token

FrontendChatApi *apiInstance = [[FrontendChatApi alloc] init];

// telegram_event frontend_chat
[apiInstance frontendChatTelegramEventWith:channelID
    token:token
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendChatApi()

var channelID = channelID_example; // {String} Channel id

var token = token_example; // {String} Token

api.frontendChatTelegramEvent(channelID, token).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendChatTelegramEventExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendChatApi();
            var channelID = channelID_example;  // String | Channel id
            var token = token_example;  // String | Token

            try
            {
                // telegram_event frontend_chat
                apiInstance.frontendChatTelegramEvent(channelID, token);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendChatApi.frontendChatTelegramEvent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendChatApi();
$channelID = channelID_example; // String | Channel id
$token = token_example; // String | Token

try {
    $api_instance->frontendChatTelegramEvent($channelID, $token);
} catch (Exception $e) {
    echo 'Exception when calling FrontendChatApi->frontendChatTelegramEvent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendChatApi;

my $api_instance = WWW::SwaggerClient::FrontendChatApi->new();
my $channelID = channelID_example; # String | Channel id
my $token = token_example; # String | Token

eval { 
    $api_instance->frontendChatTelegramEvent(channelID => $channelID, token => $token);
};
if ($@) {
    warn "Exception when calling FrontendChatApi->frontendChatTelegramEvent: $@\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.FrontendChatApi()
channelID = channelID_example # String | Channel id
token = token_example # String | Token

try: 
    # telegram_event frontend_chat
    api_instance.frontend_chat_telegram_event(channelID, token)
except ApiException as e:
    print("Exception when calling FrontendChatApi->frontendChatTelegramEvent: %s\n" % e)

Parameters

Path parameters
Name Description
channelID*
String
Channel id
Required
token*
String
Token
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 404 - Not Found


frontendChatTwilioWhatsappMessage

twilio_whatsapp_message frontend_chat

Receive whatsapp message events webhook.


/0.0.1/frontend/chats/twilio_whatsapp/message

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/frontend/chats/twilio_whatsapp/message"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendChatApi;

import java.io.File;
import java.util.*;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        
        FrontendChatApi apiInstance = new FrontendChatApi();
        try {
            apiInstance.frontendChatTwilioWhatsappMessage();
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatTwilioWhatsappMessage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendChatApi;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        FrontendChatApi apiInstance = new FrontendChatApi();
        try {
            apiInstance.frontendChatTwilioWhatsappMessage();
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatTwilioWhatsappMessage");
            e.printStackTrace();
        }
    }
}

FrontendChatApi *apiInstance = [[FrontendChatApi alloc] init];

// twilio_whatsapp_message frontend_chat
[apiInstance frontendChatTwilioWhatsappMessageWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendChatApi()
api.frontendChatTwilioWhatsappMessage().then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendChatTwilioWhatsappMessageExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendChatApi();

            try
            {
                // twilio_whatsapp_message frontend_chat
                apiInstance.frontendChatTwilioWhatsappMessage();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendChatApi.frontendChatTwilioWhatsappMessage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendChatApi();

try {
    $api_instance->frontendChatTwilioWhatsappMessage();
} catch (Exception $e) {
    echo 'Exception when calling FrontendChatApi->frontendChatTwilioWhatsappMessage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendChatApi;

my $api_instance = WWW::SwaggerClient::FrontendChatApi->new();

eval { 
    $api_instance->frontendChatTwilioWhatsappMessage();
};
if ($@) {
    warn "Exception when calling FrontendChatApi->frontendChatTwilioWhatsappMessage: $@\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.FrontendChatApi()

try: 
    # twilio_whatsapp_message frontend_chat
    api_instance.frontend_chat_twilio_whatsapp_message()
except ApiException as e:
    print("Exception when calling FrontendChatApi->frontendChatTwilioWhatsappMessage: %s\n" % e)

Parameters

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 404 - Not Found


frontendChatTwilioWhatsappStatus

twilio_whatsapp_status frontend_chat

Receive whatsapp message status events webhook.


/0.0.1/frontend/chats/twilio_whatsapp/status/{messageID}

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/frontend/chats/twilio_whatsapp/status/{messageID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendChatApi;

import java.io.File;
import java.util.*;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        
        FrontendChatApi apiInstance = new FrontendChatApi();
        String messageID = messageID_example; // String | Message id
        try {
            apiInstance.frontendChatTwilioWhatsappStatus(messageID);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatTwilioWhatsappStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendChatApi;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        FrontendChatApi apiInstance = new FrontendChatApi();
        String messageID = messageID_example; // String | Message id
        try {
            apiInstance.frontendChatTwilioWhatsappStatus(messageID);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatTwilioWhatsappStatus");
            e.printStackTrace();
        }
    }
}
String *messageID = messageID_example; // Message id

FrontendChatApi *apiInstance = [[FrontendChatApi alloc] init];

// twilio_whatsapp_status frontend_chat
[apiInstance frontendChatTwilioWhatsappStatusWith:messageID
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendChatApi()

var messageID = messageID_example; // {String} Message id

api.frontendChatTwilioWhatsappStatus(messageID).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendChatTwilioWhatsappStatusExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendChatApi();
            var messageID = messageID_example;  // String | Message id

            try
            {
                // twilio_whatsapp_status frontend_chat
                apiInstance.frontendChatTwilioWhatsappStatus(messageID);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendChatApi.frontendChatTwilioWhatsappStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendChatApi();
$messageID = messageID_example; // String | Message id

try {
    $api_instance->frontendChatTwilioWhatsappStatus($messageID);
} catch (Exception $e) {
    echo 'Exception when calling FrontendChatApi->frontendChatTwilioWhatsappStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendChatApi;

my $api_instance = WWW::SwaggerClient::FrontendChatApi->new();
my $messageID = messageID_example; # String | Message id

eval { 
    $api_instance->frontendChatTwilioWhatsappStatus(messageID => $messageID);
};
if ($@) {
    warn "Exception when calling FrontendChatApi->frontendChatTwilioWhatsappStatus: $@\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.FrontendChatApi()
messageID = messageID_example # String | Message id

try: 
    # twilio_whatsapp_status frontend_chat
    api_instance.frontend_chat_twilio_whatsapp_status(messageID)
except ApiException as e:
    print("Exception when calling FrontendChatApi->frontendChatTwilioWhatsappStatus: %s\n" % e)

Parameters

Path parameters
Name Description
messageID*
String
Message id
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 404 - Not Found


frontendChatTwitterEvents

twitter_events frontend_chat

Receive twitter events webhook.


/0.0.1/frontend/chats/twitter/event

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/frontend/chats/twitter/event"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendChatApi;

import java.io.File;
import java.util.*;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        
        FrontendChatApi apiInstance = new FrontendChatApi();
        try {
            apiInstance.frontendChatTwitterEvents();
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatTwitterEvents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendChatApi;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        FrontendChatApi apiInstance = new FrontendChatApi();
        try {
            apiInstance.frontendChatTwitterEvents();
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatTwitterEvents");
            e.printStackTrace();
        }
    }
}

FrontendChatApi *apiInstance = [[FrontendChatApi alloc] init];

// twitter_events frontend_chat
[apiInstance frontendChatTwitterEventsWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendChatApi()
api.frontendChatTwitterEvents().then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendChatTwitterEventsExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendChatApi();

            try
            {
                // twitter_events frontend_chat
                apiInstance.frontendChatTwitterEvents();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendChatApi.frontendChatTwitterEvents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendChatApi();

try {
    $api_instance->frontendChatTwitterEvents();
} catch (Exception $e) {
    echo 'Exception when calling FrontendChatApi->frontendChatTwitterEvents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendChatApi;

my $api_instance = WWW::SwaggerClient::FrontendChatApi->new();

eval { 
    $api_instance->frontendChatTwitterEvents();
};
if ($@) {
    warn "Exception when calling FrontendChatApi->frontendChatTwitterEvents: $@\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.FrontendChatApi()

try: 
    # twitter_events frontend_chat
    api_instance.frontend_chat_twitter_events()
except ApiException as e:
    print("Exception when calling FrontendChatApi->frontendChatTwitterEvents: %s\n" % e)

Parameters

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 404 - Not Found


frontendChatTwitterEventsVerify

twitter_events_verify frontend_chat

Verify twitter events webhook.


/0.0.1/frontend/chats/twitter/event

Usage and SDK Samples

curl -X GET "https://api.quriobot.com/0.0.1/frontend/chats/twitter/event"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendChatApi;

import java.io.File;
import java.util.*;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        
        FrontendChatApi apiInstance = new FrontendChatApi();
        try {
            Twitter_events_verify_response result = apiInstance.frontendChatTwitterEventsVerify();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatTwitterEventsVerify");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendChatApi;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        FrontendChatApi apiInstance = new FrontendChatApi();
        try {
            Twitter_events_verify_response result = apiInstance.frontendChatTwitterEventsVerify();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatTwitterEventsVerify");
            e.printStackTrace();
        }
    }
}

FrontendChatApi *apiInstance = [[FrontendChatApi alloc] init];

// twitter_events_verify frontend_chat
[apiInstance frontendChatTwitterEventsVerifyWithCompletionHandler: 
              ^(Twitter_events_verify_response output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendChatApi()
api.frontendChatTwitterEventsVerify().then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendChatTwitterEventsVerifyExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendChatApi();

            try
            {
                // twitter_events_verify frontend_chat
                Twitter_events_verify_response result = apiInstance.frontendChatTwitterEventsVerify();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendChatApi.frontendChatTwitterEventsVerify: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendChatApi();

try {
    $result = $api_instance->frontendChatTwitterEventsVerify();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FrontendChatApi->frontendChatTwitterEventsVerify: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendChatApi;

my $api_instance = WWW::SwaggerClient::FrontendChatApi->new();

eval { 
    my $result = $api_instance->frontendChatTwitterEventsVerify();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FrontendChatApi->frontendChatTwitterEventsVerify: $@\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.FrontendChatApi()

try: 
    # twitter_events_verify frontend_chat
    api_response = api_instance.frontend_chat_twitter_events_verify()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FrontendChatApi->frontendChatTwitterEventsVerify: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 400 - Bad Request


frontendChatViberEvent

viber_event frontend_chat

Receive Viber event webhook.


/0.0.1/frontend/chats/viber/events/{channelID}

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/frontend/chats/viber/events/{channelID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendChatApi;

import java.io.File;
import java.util.*;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        
        FrontendChatApi apiInstance = new FrontendChatApi();
        String channelID = channelID_example; // String | Channel id
        try {
            apiInstance.frontendChatViberEvent(channelID);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatViberEvent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendChatApi;

public class FrontendChatApiExample {

    public static void main(String[] args) {
        FrontendChatApi apiInstance = new FrontendChatApi();
        String channelID = channelID_example; // String | Channel id
        try {
            apiInstance.frontendChatViberEvent(channelID);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendChatApi#frontendChatViberEvent");
            e.printStackTrace();
        }
    }
}
String *channelID = channelID_example; // Channel id

FrontendChatApi *apiInstance = [[FrontendChatApi alloc] init];

// viber_event frontend_chat
[apiInstance frontendChatViberEventWith:channelID
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendChatApi()

var channelID = channelID_example; // {String} Channel id

api.frontendChatViberEvent(channelID).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendChatViberEventExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendChatApi();
            var channelID = channelID_example;  // String | Channel id

            try
            {
                // viber_event frontend_chat
                apiInstance.frontendChatViberEvent(channelID);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendChatApi.frontendChatViberEvent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendChatApi();
$channelID = channelID_example; // String | Channel id

try {
    $api_instance->frontendChatViberEvent($channelID);
} catch (Exception $e) {
    echo 'Exception when calling FrontendChatApi->frontendChatViberEvent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendChatApi;

my $api_instance = WWW::SwaggerClient::FrontendChatApi->new();
my $channelID = channelID_example; # String | Channel id

eval { 
    $api_instance->frontendChatViberEvent(channelID => $channelID);
};
if ($@) {
    warn "Exception when calling FrontendChatApi->frontendChatViberEvent: $@\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.FrontendChatApi()
channelID = channelID_example # String | Channel id

try: 
    # viber_event frontend_chat
    api_instance.frontend_chat_viber_event(channelID)
except ApiException as e:
    print("Exception when calling FrontendChatApi->frontendChatViberEvent: %s\n" % e)

Parameters

Path parameters
Name Description
channelID*
String
Channel id
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 404 - Not Found


FrontendKnowledgeBase

frontendKnowledgeBaseSearch

search frontend_knowledge_base

Search among the knowledge base(s)


/0.0.1/frontend/knowledge_bases/search

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/frontend/knowledge_bases/search"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendKnowledgeBaseApi;

import java.io.File;
import java.util.*;

public class FrontendKnowledgeBaseApiExample {

    public static void main(String[] args) {
        
        FrontendKnowledgeBaseApi apiInstance = new FrontendKnowledgeBaseApi();
        String organisation = organisation_example; // String | 
        KnowledgeBaseSearchPayload payload = ; // KnowledgeBaseSearchPayload | Knowledge base search payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String userAgent = userAgent_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Knowledge_base_search_result_item_collection result = apiInstance.frontendKnowledgeBaseSearch(organisation, payload, acceptLanguage, bot, userAgent, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendKnowledgeBaseApi#frontendKnowledgeBaseSearch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendKnowledgeBaseApi;

public class FrontendKnowledgeBaseApiExample {

    public static void main(String[] args) {
        FrontendKnowledgeBaseApi apiInstance = new FrontendKnowledgeBaseApi();
        String organisation = organisation_example; // String | 
        KnowledgeBaseSearchPayload payload = ; // KnowledgeBaseSearchPayload | Knowledge base search payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String userAgent = userAgent_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Knowledge_base_search_result_item_collection result = apiInstance.frontendKnowledgeBaseSearch(organisation, payload, acceptLanguage, bot, userAgent, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendKnowledgeBaseApi#frontendKnowledgeBaseSearch");
            e.printStackTrace();
        }
    }
}
String *organisation = organisation_example; // 
KnowledgeBaseSearchPayload *payload = ; // Knowledge base search payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *userAgent = userAgent_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

FrontendKnowledgeBaseApi *apiInstance = [[FrontendKnowledgeBaseApi alloc] init];

// search frontend_knowledge_base
[apiInstance frontendKnowledgeBaseSearchWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    bot:bot
    userAgent:userAgent
    xForwardedFor:xForwardedFor
              completionHandler: ^(Knowledge_base_search_result_item_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendKnowledgeBaseApi()

var organisation = organisation_example; // {String} 

var payload = ; // {KnowledgeBaseSearchPayload} Knowledge base search payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'userAgent': userAgent_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.frontendKnowledgeBaseSearch(organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendKnowledgeBaseSearchExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendKnowledgeBaseApi();
            var organisation = organisation_example;  // String | 
            var payload = new KnowledgeBaseSearchPayload(); // KnowledgeBaseSearchPayload | Knowledge base search payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var userAgent = userAgent_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // search frontend_knowledge_base
                Knowledge_base_search_result_item_collection result = apiInstance.frontendKnowledgeBaseSearch(organisation, payload, acceptLanguage, bot, userAgent, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendKnowledgeBaseApi.frontendKnowledgeBaseSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendKnowledgeBaseApi();
$organisation = organisation_example; // String | 
$payload = ; // KnowledgeBaseSearchPayload | Knowledge base search payload
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$userAgent = userAgent_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->frontendKnowledgeBaseSearch($organisation, $payload, $acceptLanguage, $bot, $userAgent, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FrontendKnowledgeBaseApi->frontendKnowledgeBaseSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendKnowledgeBaseApi;

my $api_instance = WWW::SwaggerClient::FrontendKnowledgeBaseApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::KnowledgeBaseSearchPayload->new(); # KnowledgeBaseSearchPayload | Knowledge base search payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $userAgent = userAgent_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->frontendKnowledgeBaseSearch(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, bot => $bot, userAgent => $userAgent, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FrontendKnowledgeBaseApi->frontendKnowledgeBaseSearch: $@\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.FrontendKnowledgeBaseApi()
organisation = organisation_example # String | 
payload =  # KnowledgeBaseSearchPayload | Knowledge base search payload
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
userAgent = userAgent_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # search frontend_knowledge_base
    api_response = api_instance.frontend_knowledge_base_search(organisation, payload, acceptLanguage=acceptLanguage, bot=bot, userAgent=userAgent, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FrontendKnowledgeBaseApi->frontendKnowledgeBaseSearch: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Bot
String
Organisation*
String
Required
User-Agent
String
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


FrontendLiveChat

frontendLiveChatClose

close frontend_live_chat

Close chat


/0.0.1/frontend/live_chats/{id}/close

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/frontend/live_chats/{id}/close"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendLiveChatApi;

import java.io.File;
import java.util.*;

public class FrontendLiveChatApiExample {

    public static void main(String[] args) {
        
        FrontendLiveChatApi apiInstance = new FrontendLiveChatApi();
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        String userAgent = userAgent_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Live_chat result = apiInstance.frontendLiveChatClose(id, organisation, acceptLanguage, bot, fields, userAgent, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendLiveChatApi#frontendLiveChatClose");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendLiveChatApi;

public class FrontendLiveChatApiExample {

    public static void main(String[] args) {
        FrontendLiveChatApi apiInstance = new FrontendLiveChatApi();
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        String userAgent = userAgent_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Live_chat result = apiInstance.frontendLiveChatClose(id, organisation, acceptLanguage, bot, fields, userAgent, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendLiveChatApi#frontendLiveChatClose");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Chat ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)
String *userAgent = userAgent_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

FrontendLiveChatApi *apiInstance = [[FrontendLiveChatApi alloc] init];

// close frontend_live_chat
[apiInstance frontendLiveChatCloseWith:id
    organisation:organisation
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
    userAgent:userAgent
    xForwardedFor:xForwardedFor
              completionHandler: ^(Live_chat output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendLiveChatApi()

var id = id_example; // {String} Chat ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example, // {String} 
  'userAgent': userAgent_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.frontendLiveChatClose(id, organisation, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendLiveChatCloseExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendLiveChatApi();
            var id = id_example;  // String | Chat ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 
            var userAgent = userAgent_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // close frontend_live_chat
                Live_chat result = apiInstance.frontendLiveChatClose(id, organisation, acceptLanguage, bot, fields, userAgent, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendLiveChatApi.frontendLiveChatClose: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendLiveChatApi();
$id = id_example; // String | Chat ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 
$userAgent = userAgent_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->frontendLiveChatClose($id, $organisation, $acceptLanguage, $bot, $fields, $userAgent, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FrontendLiveChatApi->frontendLiveChatClose: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendLiveChatApi;

my $api_instance = WWW::SwaggerClient::FrontendLiveChatApi->new();
my $id = id_example; # String | Chat ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 
my $userAgent = userAgent_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->frontendLiveChatClose(id => $id, organisation => $organisation, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields, userAgent => $userAgent, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FrontendLiveChatApi->frontendLiveChatClose: $@\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.FrontendLiveChatApi()
id = id_example # String | Chat ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)
userAgent = userAgent_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # close frontend_live_chat
    api_response = api_instance.frontend_live_chat_close(id, organisation, acceptLanguage=acceptLanguage, bot=bot, fields=fields, userAgent=userAgent, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FrontendLiveChatApi->frontendLiveChatClose: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Chat ID
Required
Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
User-Agent
String
X-Forwarded-For
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


frontendLiveChatCreate

create frontend_live_chat

Create chat


/0.0.1/frontend/live_chats

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/frontend/live_chats"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendLiveChatApi;

import java.io.File;
import java.util.*;

public class FrontendLiveChatApiExample {

    public static void main(String[] args) {
        
        FrontendLiveChatApi apiInstance = new FrontendLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatPayload payload = ; // LiveChatPayload | Live chat payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        String userAgent = userAgent_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Live_chat result = apiInstance.frontendLiveChatCreate(organisation, payload, acceptLanguage, bot, fields, userAgent, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendLiveChatApi#frontendLiveChatCreate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendLiveChatApi;

public class FrontendLiveChatApiExample {

    public static void main(String[] args) {
        FrontendLiveChatApi apiInstance = new FrontendLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatPayload payload = ; // LiveChatPayload | Live chat payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        String userAgent = userAgent_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Live_chat result = apiInstance.frontendLiveChatCreate(organisation, payload, acceptLanguage, bot, fields, userAgent, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendLiveChatApi#frontendLiveChatCreate");
            e.printStackTrace();
        }
    }
}
String *organisation = organisation_example; // 
LiveChatPayload *payload = ; // Live chat payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)
String *userAgent = userAgent_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

FrontendLiveChatApi *apiInstance = [[FrontendLiveChatApi alloc] init];

// create frontend_live_chat
[apiInstance frontendLiveChatCreateWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
    userAgent:userAgent
    xForwardedFor:xForwardedFor
              completionHandler: ^(Live_chat output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendLiveChatApi()

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatPayload} Live chat payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example, // {String} 
  'userAgent': userAgent_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.frontendLiveChatCreate(organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendLiveChatCreateExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendLiveChatApi();
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatPayload(); // LiveChatPayload | Live chat payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 
            var userAgent = userAgent_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // create frontend_live_chat
                Live_chat result = apiInstance.frontendLiveChatCreate(organisation, payload, acceptLanguage, bot, fields, userAgent, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendLiveChatApi.frontendLiveChatCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendLiveChatApi();
$organisation = organisation_example; // String | 
$payload = ; // LiveChatPayload | Live chat payload
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 
$userAgent = userAgent_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->frontendLiveChatCreate($organisation, $payload, $acceptLanguage, $bot, $fields, $userAgent, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FrontendLiveChatApi->frontendLiveChatCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendLiveChatApi;

my $api_instance = WWW::SwaggerClient::FrontendLiveChatApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatPayload->new(); # LiveChatPayload | Live chat payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 
my $userAgent = userAgent_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->frontendLiveChatCreate(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields, userAgent => $userAgent, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FrontendLiveChatApi->frontendLiveChatCreate: $@\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.FrontendLiveChatApi()
organisation = organisation_example # String | 
payload =  # LiveChatPayload | Live chat payload
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)
userAgent = userAgent_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # create frontend_live_chat
    api_response = api_instance.frontend_live_chat_create(organisation, payload, acceptLanguage=acceptLanguage, bot=bot, fields=fields, userAgent=userAgent, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FrontendLiveChatApi->frontendLiveChatCreate: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
User-Agent
String
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


frontendLiveChatCreateAttachment

create_attachment frontend_live_chat

Create chat attachment


/0.0.1/frontend/live_chats/{id}/attachments

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/frontend/live_chats/{id}/attachments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendLiveChatApi;

import java.io.File;
import java.util.*;

public class FrontendLiveChatApiExample {

    public static void main(String[] args) {
        
        FrontendLiveChatApi apiInstance = new FrontendLiveChatApi();
        String id = id_example; // String | 
        String organisation = organisation_example; // String | 
        LiveChatAttachmentPayload payload = ; // LiveChatAttachmentPayload | Live chat attachment payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        String userAgent = userAgent_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Live_chat_attachment result = apiInstance.frontendLiveChatCreateAttachment(id, organisation, payload, acceptLanguage, bot, fields, userAgent, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendLiveChatApi#frontendLiveChatCreateAttachment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendLiveChatApi;

public class FrontendLiveChatApiExample {

    public static void main(String[] args) {
        FrontendLiveChatApi apiInstance = new FrontendLiveChatApi();
        String id = id_example; // String | 
        String organisation = organisation_example; // String | 
        LiveChatAttachmentPayload payload = ; // LiveChatAttachmentPayload | Live chat attachment payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        String userAgent = userAgent_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Live_chat_attachment result = apiInstance.frontendLiveChatCreateAttachment(id, organisation, payload, acceptLanguage, bot, fields, userAgent, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendLiveChatApi#frontendLiveChatCreateAttachment");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // 
String *organisation = organisation_example; // 
LiveChatAttachmentPayload *payload = ; // Live chat attachment payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)
String *userAgent = userAgent_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

FrontendLiveChatApi *apiInstance = [[FrontendLiveChatApi alloc] init];

// create_attachment frontend_live_chat
[apiInstance frontendLiveChatCreateAttachmentWith:id
    organisation:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
    userAgent:userAgent
    xForwardedFor:xForwardedFor
              completionHandler: ^(Live_chat_attachment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendLiveChatApi()

var id = id_example; // {String} 

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatAttachmentPayload} Live chat attachment payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example, // {String} 
  'userAgent': userAgent_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.frontendLiveChatCreateAttachment(id, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendLiveChatCreateAttachmentExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendLiveChatApi();
            var id = id_example;  // String | 
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatAttachmentPayload(); // LiveChatAttachmentPayload | Live chat attachment payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 
            var userAgent = userAgent_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // create_attachment frontend_live_chat
                Live_chat_attachment result = apiInstance.frontendLiveChatCreateAttachment(id, organisation, payload, acceptLanguage, bot, fields, userAgent, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendLiveChatApi.frontendLiveChatCreateAttachment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendLiveChatApi();
$id = id_example; // String | 
$organisation = organisation_example; // String | 
$payload = ; // LiveChatAttachmentPayload | Live chat attachment payload
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 
$userAgent = userAgent_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->frontendLiveChatCreateAttachment($id, $organisation, $payload, $acceptLanguage, $bot, $fields, $userAgent, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FrontendLiveChatApi->frontendLiveChatCreateAttachment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendLiveChatApi;

my $api_instance = WWW::SwaggerClient::FrontendLiveChatApi->new();
my $id = id_example; # String | 
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatAttachmentPayload->new(); # LiveChatAttachmentPayload | Live chat attachment payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 
my $userAgent = userAgent_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->frontendLiveChatCreateAttachment(id => $id, organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields, userAgent => $userAgent, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FrontendLiveChatApi->frontendLiveChatCreateAttachment: $@\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.FrontendLiveChatApi()
id = id_example # String | 
organisation = organisation_example # String | 
payload =  # LiveChatAttachmentPayload | Live chat attachment payload
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)
userAgent = userAgent_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # create_attachment frontend_live_chat
    api_response = api_instance.frontend_live_chat_create_attachment(id, organisation, payload, acceptLanguage=acceptLanguage, bot=bot, fields=fields, userAgent=userAgent, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FrontendLiveChatApi->frontendLiveChatCreateAttachment: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required
Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
User-Agent
String
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


frontendLiveChatCreateMessage

create_message frontend_live_chat

Create chat message


/0.0.1/frontend/live_chats/{id}/messages

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/frontend/live_chats/{id}/messages"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendLiveChatApi;

import java.io.File;
import java.util.*;

public class FrontendLiveChatApiExample {

    public static void main(String[] args) {
        
        FrontendLiveChatApi apiInstance = new FrontendLiveChatApi();
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        LiveChatMessagePayload payload = ; // LiveChatMessagePayload | Live chat message payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        String userAgent = userAgent_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Live_chat_message result = apiInstance.frontendLiveChatCreateMessage(id, organisation, payload, acceptLanguage, bot, fields, userAgent, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendLiveChatApi#frontendLiveChatCreateMessage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendLiveChatApi;

public class FrontendLiveChatApiExample {

    public static void main(String[] args) {
        FrontendLiveChatApi apiInstance = new FrontendLiveChatApi();
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        LiveChatMessagePayload payload = ; // LiveChatMessagePayload | Live chat message payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        String userAgent = userAgent_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Live_chat_message result = apiInstance.frontendLiveChatCreateMessage(id, organisation, payload, acceptLanguage, bot, fields, userAgent, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendLiveChatApi#frontendLiveChatCreateMessage");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Chat ID
String *organisation = organisation_example; // 
LiveChatMessagePayload *payload = ; // Live chat message payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)
String *userAgent = userAgent_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

FrontendLiveChatApi *apiInstance = [[FrontendLiveChatApi alloc] init];

// create_message frontend_live_chat
[apiInstance frontendLiveChatCreateMessageWith:id
    organisation:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
    userAgent:userAgent
    xForwardedFor:xForwardedFor
              completionHandler: ^(Live_chat_message output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendLiveChatApi()

var id = id_example; // {String} Chat ID

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatMessagePayload} Live chat message payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example, // {String} 
  'userAgent': userAgent_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.frontendLiveChatCreateMessage(id, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendLiveChatCreateMessageExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendLiveChatApi();
            var id = id_example;  // String | Chat ID
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatMessagePayload(); // LiveChatMessagePayload | Live chat message payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 
            var userAgent = userAgent_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // create_message frontend_live_chat
                Live_chat_message result = apiInstance.frontendLiveChatCreateMessage(id, organisation, payload, acceptLanguage, bot, fields, userAgent, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendLiveChatApi.frontendLiveChatCreateMessage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendLiveChatApi();
$id = id_example; // String | Chat ID
$organisation = organisation_example; // String | 
$payload = ; // LiveChatMessagePayload | Live chat message payload
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 
$userAgent = userAgent_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->frontendLiveChatCreateMessage($id, $organisation, $payload, $acceptLanguage, $bot, $fields, $userAgent, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FrontendLiveChatApi->frontendLiveChatCreateMessage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendLiveChatApi;

my $api_instance = WWW::SwaggerClient::FrontendLiveChatApi->new();
my $id = id_example; # String | Chat ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatMessagePayload->new(); # LiveChatMessagePayload | Live chat message payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 
my $userAgent = userAgent_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->frontendLiveChatCreateMessage(id => $id, organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields, userAgent => $userAgent, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FrontendLiveChatApi->frontendLiveChatCreateMessage: $@\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.FrontendLiveChatApi()
id = id_example # String | Chat ID
organisation = organisation_example # String | 
payload =  # LiveChatMessagePayload | Live chat message payload
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)
userAgent = userAgent_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # create_message frontend_live_chat
    api_response = api_instance.frontend_live_chat_create_message(id, organisation, payload, acceptLanguage=acceptLanguage, bot=bot, fields=fields, userAgent=userAgent, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FrontendLiveChatApi->frontendLiveChatCreateMessage: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Chat ID
Required
Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
User-Agent
String
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


frontendLiveChatDeleteAttachment

delete_attachment frontend_live_chat

Delete chat attachment


/0.0.1/frontend/live_chats/{id}/attachments/{attachment_id}

Usage and SDK Samples

curl -X DELETE "https://api.quriobot.com/0.0.1/frontend/live_chats/{id}/attachments/{attachment_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendLiveChatApi;

import java.io.File;
import java.util.*;

public class FrontendLiveChatApiExample {

    public static void main(String[] args) {
        
        FrontendLiveChatApi apiInstance = new FrontendLiveChatApi();
        String attachmentId = attachmentId_example; // String | Chat attachment ID
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        String userAgent = userAgent_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            apiInstance.frontendLiveChatDeleteAttachment(attachmentId, id, organisation, acceptLanguage, bot, fields, userAgent, xForwardedFor);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendLiveChatApi#frontendLiveChatDeleteAttachment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendLiveChatApi;

public class FrontendLiveChatApiExample {

    public static void main(String[] args) {
        FrontendLiveChatApi apiInstance = new FrontendLiveChatApi();
        String attachmentId = attachmentId_example; // String | Chat attachment ID
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        String userAgent = userAgent_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            apiInstance.frontendLiveChatDeleteAttachment(attachmentId, id, organisation, acceptLanguage, bot, fields, userAgent, xForwardedFor);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendLiveChatApi#frontendLiveChatDeleteAttachment");
            e.printStackTrace();
        }
    }
}
String *attachmentId = attachmentId_example; // Chat attachment ID
String *id = id_example; // Chat ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)
String *userAgent = userAgent_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

FrontendLiveChatApi *apiInstance = [[FrontendLiveChatApi alloc] init];

// delete_attachment frontend_live_chat
[apiInstance frontendLiveChatDeleteAttachmentWith:attachmentId
    id:id
    organisation:organisation
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
    userAgent:userAgent
    xForwardedFor:xForwardedFor
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendLiveChatApi()

var attachmentId = attachmentId_example; // {String} Chat attachment ID

var id = id_example; // {String} Chat ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example, // {String} 
  'userAgent': userAgent_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.frontendLiveChatDeleteAttachment(attachmentId, id, organisation, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendLiveChatDeleteAttachmentExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendLiveChatApi();
            var attachmentId = attachmentId_example;  // String | Chat attachment ID
            var id = id_example;  // String | Chat ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 
            var userAgent = userAgent_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // delete_attachment frontend_live_chat
                apiInstance.frontendLiveChatDeleteAttachment(attachmentId, id, organisation, acceptLanguage, bot, fields, userAgent, xForwardedFor);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendLiveChatApi.frontendLiveChatDeleteAttachment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendLiveChatApi();
$attachmentId = attachmentId_example; // String | Chat attachment ID
$id = id_example; // String | Chat ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 
$userAgent = userAgent_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $api_instance->frontendLiveChatDeleteAttachment($attachmentId, $id, $organisation, $acceptLanguage, $bot, $fields, $userAgent, $xForwardedFor);
} catch (Exception $e) {
    echo 'Exception when calling FrontendLiveChatApi->frontendLiveChatDeleteAttachment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendLiveChatApi;

my $api_instance = WWW::SwaggerClient::FrontendLiveChatApi->new();
my $attachmentId = attachmentId_example; # String | Chat attachment ID
my $id = id_example; # String | Chat ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 
my $userAgent = userAgent_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    $api_instance->frontendLiveChatDeleteAttachment(attachmentId => $attachmentId, id => $id, organisation => $organisation, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields, userAgent => $userAgent, xForwardedFor => $xForwardedFor);
};
if ($@) {
    warn "Exception when calling FrontendLiveChatApi->frontendLiveChatDeleteAttachment: $@\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.FrontendLiveChatApi()
attachmentId = attachmentId_example # String | Chat attachment ID
id = id_example # String | Chat ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)
userAgent = userAgent_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # delete_attachment frontend_live_chat
    api_instance.frontend_live_chat_delete_attachment(attachmentId, id, organisation, acceptLanguage=acceptLanguage, bot=bot, fields=fields, userAgent=userAgent, xForwardedFor=xForwardedFor)
except ApiException as e:
    print("Exception when calling FrontendLiveChatApi->frontendLiveChatDeleteAttachment: %s\n" % e)

Parameters

Path parameters
Name Description
attachment_id*
String
Chat attachment ID
Required
id*
String
Chat ID
Required
Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
User-Agent
String
X-Forwarded-For
String

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


frontendLiveChatList

list frontend_live_chat

Retrieve all chats.


/0.0.1/frontend/live_chats/list

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/frontend/live_chats/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendLiveChatApi;

import java.io.File;
import java.util.*;

public class FrontendLiveChatApiExample {

    public static void main(String[] args) {
        
        FrontendLiveChatApi apiInstance = new FrontendLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatCollectionPayload payload = ; // LiveChatCollectionPayload | Live chat collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        String userAgent = userAgent_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Live_chat_collection result = apiInstance.frontendLiveChatList(organisation, payload, acceptLanguage, bot, fields, userAgent, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendLiveChatApi#frontendLiveChatList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendLiveChatApi;

public class FrontendLiveChatApiExample {

    public static void main(String[] args) {
        FrontendLiveChatApi apiInstance = new FrontendLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatCollectionPayload payload = ; // LiveChatCollectionPayload | Live chat collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        String userAgent = userAgent_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Live_chat_collection result = apiInstance.frontendLiveChatList(organisation, payload, acceptLanguage, bot, fields, userAgent, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendLiveChatApi#frontendLiveChatList");
            e.printStackTrace();
        }
    }
}
String *organisation = organisation_example; // 
LiveChatCollectionPayload *payload = ; // Live chat collection payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)
String *userAgent = userAgent_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

FrontendLiveChatApi *apiInstance = [[FrontendLiveChatApi alloc] init];

// list frontend_live_chat
[apiInstance frontendLiveChatListWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
    userAgent:userAgent
    xForwardedFor:xForwardedFor
              completionHandler: ^(Live_chat_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendLiveChatApi()

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatCollectionPayload} Live chat collection payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example, // {String} 
  'userAgent': userAgent_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.frontendLiveChatList(organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendLiveChatListExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendLiveChatApi();
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatCollectionPayload(); // LiveChatCollectionPayload | Live chat collection payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 
            var userAgent = userAgent_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // list frontend_live_chat
                Live_chat_collection result = apiInstance.frontendLiveChatList(organisation, payload, acceptLanguage, bot, fields, userAgent, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendLiveChatApi.frontendLiveChatList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendLiveChatApi();
$organisation = organisation_example; // String | 
$payload = ; // LiveChatCollectionPayload | Live chat collection payload
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 
$userAgent = userAgent_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->frontendLiveChatList($organisation, $payload, $acceptLanguage, $bot, $fields, $userAgent, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FrontendLiveChatApi->frontendLiveChatList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendLiveChatApi;

my $api_instance = WWW::SwaggerClient::FrontendLiveChatApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatCollectionPayload->new(); # LiveChatCollectionPayload | Live chat collection payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 
my $userAgent = userAgent_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->frontendLiveChatList(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields, userAgent => $userAgent, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FrontendLiveChatApi->frontendLiveChatList: $@\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.FrontendLiveChatApi()
organisation = organisation_example # String | 
payload =  # LiveChatCollectionPayload | Live chat collection payload
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)
userAgent = userAgent_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # list frontend_live_chat
    api_response = api_instance.frontend_live_chat_list(organisation, payload, acceptLanguage=acceptLanguage, bot=bot, fields=fields, userAgent=userAgent, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FrontendLiveChatApi->frontendLiveChatList: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
User-Agent
String
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden


frontendLiveChatListMessages

list_messages frontend_live_chat

List chat messages


/0.0.1/frontend/live_chats/{id}/messages/list

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/frontend/live_chats/{id}/messages/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendLiveChatApi;

import java.io.File;
import java.util.*;

public class FrontendLiveChatApiExample {

    public static void main(String[] args) {
        
        FrontendLiveChatApi apiInstance = new FrontendLiveChatApi();
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        LiveChatMessageCollectionPayload payload = ; // LiveChatMessageCollectionPayload | Live chat message collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        String userAgent = userAgent_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Live_chat_message_collection result = apiInstance.frontendLiveChatListMessages(id, organisation, payload, acceptLanguage, bot, fields, userAgent, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendLiveChatApi#frontendLiveChatListMessages");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendLiveChatApi;

public class FrontendLiveChatApiExample {

    public static void main(String[] args) {
        FrontendLiveChatApi apiInstance = new FrontendLiveChatApi();
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        LiveChatMessageCollectionPayload payload = ; // LiveChatMessageCollectionPayload | Live chat message collection payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        String userAgent = userAgent_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Live_chat_message_collection result = apiInstance.frontendLiveChatListMessages(id, organisation, payload, acceptLanguage, bot, fields, userAgent, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendLiveChatApi#frontendLiveChatListMessages");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Chat ID
String *organisation = organisation_example; // 
LiveChatMessageCollectionPayload *payload = ; // Live chat message collection payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)
String *userAgent = userAgent_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

FrontendLiveChatApi *apiInstance = [[FrontendLiveChatApi alloc] init];

// list_messages frontend_live_chat
[apiInstance frontendLiveChatListMessagesWith:id
    organisation:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
    userAgent:userAgent
    xForwardedFor:xForwardedFor
              completionHandler: ^(Live_chat_message_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendLiveChatApi()

var id = id_example; // {String} Chat ID

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatMessageCollectionPayload} Live chat message collection payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example, // {String} 
  'userAgent': userAgent_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.frontendLiveChatListMessages(id, organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendLiveChatListMessagesExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendLiveChatApi();
            var id = id_example;  // String | Chat ID
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatMessageCollectionPayload(); // LiveChatMessageCollectionPayload | Live chat message collection payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 
            var userAgent = userAgent_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // list_messages frontend_live_chat
                Live_chat_message_collection result = apiInstance.frontendLiveChatListMessages(id, organisation, payload, acceptLanguage, bot, fields, userAgent, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendLiveChatApi.frontendLiveChatListMessages: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendLiveChatApi();
$id = id_example; // String | Chat ID
$organisation = organisation_example; // String | 
$payload = ; // LiveChatMessageCollectionPayload | Live chat message collection payload
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 
$userAgent = userAgent_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->frontendLiveChatListMessages($id, $organisation, $payload, $acceptLanguage, $bot, $fields, $userAgent, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FrontendLiveChatApi->frontendLiveChatListMessages: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendLiveChatApi;

my $api_instance = WWW::SwaggerClient::FrontendLiveChatApi->new();
my $id = id_example; # String | Chat ID
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatMessageCollectionPayload->new(); # LiveChatMessageCollectionPayload | Live chat message collection payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 
my $userAgent = userAgent_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->frontendLiveChatListMessages(id => $id, organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields, userAgent => $userAgent, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FrontendLiveChatApi->frontendLiveChatListMessages: $@\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.FrontendLiveChatApi()
id = id_example # String | Chat ID
organisation = organisation_example # String | 
payload =  # LiveChatMessageCollectionPayload | Live chat message collection payload
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)
userAgent = userAgent_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # list_messages frontend_live_chat
    api_response = api_instance.frontend_live_chat_list_messages(id, organisation, payload, acceptLanguage=acceptLanguage, bot=bot, fields=fields, userAgent=userAgent, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FrontendLiveChatApi->frontendLiveChatListMessages: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Chat ID
Required
Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
User-Agent
String
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


frontendLiveChatPreview

preview frontend_live_chat

Get chat preview


/0.0.1/frontend/live_chats/preview

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/frontend/live_chats/preview"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendLiveChatApi;

import java.io.File;
import java.util.*;

public class FrontendLiveChatApiExample {

    public static void main(String[] args) {
        
        FrontendLiveChatApi apiInstance = new FrontendLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatPayload payload = ; // LiveChatPayload | Live chat payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        String userAgent = userAgent_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Live_chat result = apiInstance.frontendLiveChatPreview(organisation, payload, acceptLanguage, bot, fields, userAgent, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendLiveChatApi#frontendLiveChatPreview");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendLiveChatApi;

public class FrontendLiveChatApiExample {

    public static void main(String[] args) {
        FrontendLiveChatApi apiInstance = new FrontendLiveChatApi();
        String organisation = organisation_example; // String | 
        LiveChatPayload payload = ; // LiveChatPayload | Live chat payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        String userAgent = userAgent_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Live_chat result = apiInstance.frontendLiveChatPreview(organisation, payload, acceptLanguage, bot, fields, userAgent, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendLiveChatApi#frontendLiveChatPreview");
            e.printStackTrace();
        }
    }
}
String *organisation = organisation_example; // 
LiveChatPayload *payload = ; // Live chat payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)
String *userAgent = userAgent_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

FrontendLiveChatApi *apiInstance = [[FrontendLiveChatApi alloc] init];

// preview frontend_live_chat
[apiInstance frontendLiveChatPreviewWith:organisation
    payload:payload
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
    userAgent:userAgent
    xForwardedFor:xForwardedFor
              completionHandler: ^(Live_chat output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendLiveChatApi()

var organisation = organisation_example; // {String} 

var payload = ; // {LiveChatPayload} Live chat payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example, // {String} 
  'userAgent': userAgent_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.frontendLiveChatPreview(organisation, payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendLiveChatPreviewExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendLiveChatApi();
            var organisation = organisation_example;  // String | 
            var payload = new LiveChatPayload(); // LiveChatPayload | Live chat payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 
            var userAgent = userAgent_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // preview frontend_live_chat
                Live_chat result = apiInstance.frontendLiveChatPreview(organisation, payload, acceptLanguage, bot, fields, userAgent, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendLiveChatApi.frontendLiveChatPreview: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendLiveChatApi();
$organisation = organisation_example; // String | 
$payload = ; // LiveChatPayload | Live chat payload
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 
$userAgent = userAgent_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->frontendLiveChatPreview($organisation, $payload, $acceptLanguage, $bot, $fields, $userAgent, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FrontendLiveChatApi->frontendLiveChatPreview: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendLiveChatApi;

my $api_instance = WWW::SwaggerClient::FrontendLiveChatApi->new();
my $organisation = organisation_example; # String | 
my $payload = WWW::SwaggerClient::Object::LiveChatPayload->new(); # LiveChatPayload | Live chat payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 
my $userAgent = userAgent_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->frontendLiveChatPreview(organisation => $organisation, payload => $payload, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields, userAgent => $userAgent, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FrontendLiveChatApi->frontendLiveChatPreview: $@\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.FrontendLiveChatApi()
organisation = organisation_example # String | 
payload =  # LiveChatPayload | Live chat payload
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)
userAgent = userAgent_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # preview frontend_live_chat
    api_response = api_instance.frontend_live_chat_preview(organisation, payload, acceptLanguage=acceptLanguage, bot=bot, fields=fields, userAgent=userAgent, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FrontendLiveChatApi->frontendLiveChatPreview: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
User-Agent
String
X-Forwarded-For
String
Body parameters
Name Description
payload *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


frontendLiveChatReopen

reopen frontend_live_chat

Reopen chat


/0.0.1/frontend/live_chats/{id}/reopen

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/frontend/live_chats/{id}/reopen"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendLiveChatApi;

import java.io.File;
import java.util.*;

public class FrontendLiveChatApiExample {

    public static void main(String[] args) {
        
        FrontendLiveChatApi apiInstance = new FrontendLiveChatApi();
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        String userAgent = userAgent_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Live_chat result = apiInstance.frontendLiveChatReopen(id, organisation, acceptLanguage, bot, fields, userAgent, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendLiveChatApi#frontendLiveChatReopen");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendLiveChatApi;

public class FrontendLiveChatApiExample {

    public static void main(String[] args) {
        FrontendLiveChatApi apiInstance = new FrontendLiveChatApi();
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        String userAgent = userAgent_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Live_chat result = apiInstance.frontendLiveChatReopen(id, organisation, acceptLanguage, bot, fields, userAgent, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendLiveChatApi#frontendLiveChatReopen");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Chat ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)
String *userAgent = userAgent_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

FrontendLiveChatApi *apiInstance = [[FrontendLiveChatApi alloc] init];

// reopen frontend_live_chat
[apiInstance frontendLiveChatReopenWith:id
    organisation:organisation
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
    userAgent:userAgent
    xForwardedFor:xForwardedFor
              completionHandler: ^(Live_chat output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendLiveChatApi()

var id = id_example; // {String} Chat ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example, // {String} 
  'userAgent': userAgent_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.frontendLiveChatReopen(id, organisation, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendLiveChatReopenExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendLiveChatApi();
            var id = id_example;  // String | Chat ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 
            var userAgent = userAgent_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // reopen frontend_live_chat
                Live_chat result = apiInstance.frontendLiveChatReopen(id, organisation, acceptLanguage, bot, fields, userAgent, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendLiveChatApi.frontendLiveChatReopen: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendLiveChatApi();
$id = id_example; // String | Chat ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 
$userAgent = userAgent_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->frontendLiveChatReopen($id, $organisation, $acceptLanguage, $bot, $fields, $userAgent, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FrontendLiveChatApi->frontendLiveChatReopen: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendLiveChatApi;

my $api_instance = WWW::SwaggerClient::FrontendLiveChatApi->new();
my $id = id_example; # String | Chat ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 
my $userAgent = userAgent_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->frontendLiveChatReopen(id => $id, organisation => $organisation, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields, userAgent => $userAgent, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FrontendLiveChatApi->frontendLiveChatReopen: $@\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.FrontendLiveChatApi()
id = id_example # String | Chat ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)
userAgent = userAgent_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # reopen frontend_live_chat
    api_response = api_instance.frontend_live_chat_reopen(id, organisation, acceptLanguage=acceptLanguage, bot=bot, fields=fields, userAgent=userAgent, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FrontendLiveChatApi->frontendLiveChatReopen: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Chat ID
Required
Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
User-Agent
String
X-Forwarded-For
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


frontendLiveChatShow

show frontend_live_chat

Show chat


/0.0.1/frontend/live_chats/{id}

Usage and SDK Samples

curl -X GET "https://api.quriobot.com/0.0.1/frontend/live_chats/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendLiveChatApi;

import java.io.File;
import java.util.*;

public class FrontendLiveChatApiExample {

    public static void main(String[] args) {
        
        FrontendLiveChatApi apiInstance = new FrontendLiveChatApi();
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        String userAgent = userAgent_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Live_chat result = apiInstance.frontendLiveChatShow(id, organisation, acceptLanguage, bot, fields, userAgent, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendLiveChatApi#frontendLiveChatShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendLiveChatApi;

public class FrontendLiveChatApiExample {

    public static void main(String[] args) {
        FrontendLiveChatApi apiInstance = new FrontendLiveChatApi();
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        String userAgent = userAgent_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Live_chat result = apiInstance.frontendLiveChatShow(id, organisation, acceptLanguage, bot, fields, userAgent, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendLiveChatApi#frontendLiveChatShow");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Chat ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)
String *userAgent = userAgent_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

FrontendLiveChatApi *apiInstance = [[FrontendLiveChatApi alloc] init];

// show frontend_live_chat
[apiInstance frontendLiveChatShowWith:id
    organisation:organisation
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
    userAgent:userAgent
    xForwardedFor:xForwardedFor
              completionHandler: ^(Live_chat output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendLiveChatApi()

var id = id_example; // {String} Chat ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example, // {String} 
  'userAgent': userAgent_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.frontendLiveChatShow(id, organisation, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendLiveChatShowExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendLiveChatApi();
            var id = id_example;  // String | Chat ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 
            var userAgent = userAgent_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // show frontend_live_chat
                Live_chat result = apiInstance.frontendLiveChatShow(id, organisation, acceptLanguage, bot, fields, userAgent, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendLiveChatApi.frontendLiveChatShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendLiveChatApi();
$id = id_example; // String | Chat ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 
$userAgent = userAgent_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->frontendLiveChatShow($id, $organisation, $acceptLanguage, $bot, $fields, $userAgent, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FrontendLiveChatApi->frontendLiveChatShow: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendLiveChatApi;

my $api_instance = WWW::SwaggerClient::FrontendLiveChatApi->new();
my $id = id_example; # String | Chat ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 
my $userAgent = userAgent_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->frontendLiveChatShow(id => $id, organisation => $organisation, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields, userAgent => $userAgent, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FrontendLiveChatApi->frontendLiveChatShow: $@\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.FrontendLiveChatApi()
id = id_example # String | Chat ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)
userAgent = userAgent_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # show frontend_live_chat
    api_response = api_instance.frontend_live_chat_show(id, organisation, acceptLanguage=acceptLanguage, bot=bot, fields=fields, userAgent=userAgent, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FrontendLiveChatApi->frontendLiveChatShow: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Chat ID
Required
Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
User-Agent
String
X-Forwarded-For
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


frontendLiveChatShowAttachment

show_attachment frontend_live_chat

Show chat attachment


/0.0.1/frontend/live_chats/{id}/attachments/{attachment_id}

Usage and SDK Samples

curl -X GET "https://api.quriobot.com/0.0.1/frontend/live_chats/{id}/attachments/{attachment_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendLiveChatApi;

import java.io.File;
import java.util.*;

public class FrontendLiveChatApiExample {

    public static void main(String[] args) {
        
        FrontendLiveChatApi apiInstance = new FrontendLiveChatApi();
        String attachmentId = attachmentId_example; // String | Chat attachment ID
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        String userAgent = userAgent_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Live_chat_attachment result = apiInstance.frontendLiveChatShowAttachment(attachmentId, id, organisation, acceptLanguage, bot, fields, userAgent, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendLiveChatApi#frontendLiveChatShowAttachment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendLiveChatApi;

public class FrontendLiveChatApiExample {

    public static void main(String[] args) {
        FrontendLiveChatApi apiInstance = new FrontendLiveChatApi();
        String attachmentId = attachmentId_example; // String | Chat attachment ID
        String id = id_example; // String | Chat ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        String userAgent = userAgent_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Live_chat_attachment result = apiInstance.frontendLiveChatShowAttachment(attachmentId, id, organisation, acceptLanguage, bot, fields, userAgent, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendLiveChatApi#frontendLiveChatShowAttachment");
            e.printStackTrace();
        }
    }
}
String *attachmentId = attachmentId_example; // Chat attachment ID
String *id = id_example; // Chat ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)
String *userAgent = userAgent_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

FrontendLiveChatApi *apiInstance = [[FrontendLiveChatApi alloc] init];

// show_attachment frontend_live_chat
[apiInstance frontendLiveChatShowAttachmentWith:attachmentId
    id:id
    organisation:organisation
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
    userAgent:userAgent
    xForwardedFor:xForwardedFor
              completionHandler: ^(Live_chat_attachment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendLiveChatApi()

var attachmentId = attachmentId_example; // {String} Chat attachment ID

var id = id_example; // {String} Chat ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example, // {String} 
  'userAgent': userAgent_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.frontendLiveChatShowAttachment(attachmentId, id, organisation, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendLiveChatShowAttachmentExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendLiveChatApi();
            var attachmentId = attachmentId_example;  // String | Chat attachment ID
            var id = id_example;  // String | Chat ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 
            var userAgent = userAgent_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // show_attachment frontend_live_chat
                Live_chat_attachment result = apiInstance.frontendLiveChatShowAttachment(attachmentId, id, organisation, acceptLanguage, bot, fields, userAgent, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendLiveChatApi.frontendLiveChatShowAttachment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendLiveChatApi();
$attachmentId = attachmentId_example; // String | Chat attachment ID
$id = id_example; // String | Chat ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 
$userAgent = userAgent_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->frontendLiveChatShowAttachment($attachmentId, $id, $organisation, $acceptLanguage, $bot, $fields, $userAgent, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FrontendLiveChatApi->frontendLiveChatShowAttachment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendLiveChatApi;

my $api_instance = WWW::SwaggerClient::FrontendLiveChatApi->new();
my $attachmentId = attachmentId_example; # String | Chat attachment ID
my $id = id_example; # String | Chat ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 
my $userAgent = userAgent_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->frontendLiveChatShowAttachment(attachmentId => $attachmentId, id => $id, organisation => $organisation, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields, userAgent => $userAgent, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FrontendLiveChatApi->frontendLiveChatShowAttachment: $@\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.FrontendLiveChatApi()
attachmentId = attachmentId_example # String | Chat attachment ID
id = id_example # String | Chat ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)
userAgent = userAgent_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # show_attachment frontend_live_chat
    api_response = api_instance.frontend_live_chat_show_attachment(attachmentId, id, organisation, acceptLanguage=acceptLanguage, bot=bot, fields=fields, userAgent=userAgent, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FrontendLiveChatApi->frontendLiveChatShowAttachment: %s\n" % e)

Parameters

Path parameters
Name Description
attachment_id*
String
Chat attachment ID
Required
id*
String
Chat ID
Required
Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
User-Agent
String
X-Forwarded-For
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


frontendLiveChatShowMessage

show_message frontend_live_chat

Show chat message


/0.0.1/frontend/live_chats/{id}/messages/{message_id}

Usage and SDK Samples

curl -X GET "https://api.quriobot.com/0.0.1/frontend/live_chats/{id}/messages/{message_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendLiveChatApi;

import java.io.File;
import java.util.*;

public class FrontendLiveChatApiExample {

    public static void main(String[] args) {
        
        FrontendLiveChatApi apiInstance = new FrontendLiveChatApi();
        String id = id_example; // String | Chat ID
        String messageId = messageId_example; // String | Chat message ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        String userAgent = userAgent_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Live_chat_message result = apiInstance.frontendLiveChatShowMessage(id, messageId, organisation, acceptLanguage, bot, fields, userAgent, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendLiveChatApi#frontendLiveChatShowMessage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendLiveChatApi;

public class FrontendLiveChatApiExample {

    public static void main(String[] args) {
        FrontendLiveChatApi apiInstance = new FrontendLiveChatApi();
        String id = id_example; // String | Chat ID
        String messageId = messageId_example; // String | Chat message ID
        String organisation = organisation_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | 
        String bot = bot_example; // String | 
        String fields = fields_example; // String | 
        String userAgent = userAgent_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        try {
            Live_chat_message result = apiInstance.frontendLiveChatShowMessage(id, messageId, organisation, acceptLanguage, bot, fields, userAgent, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendLiveChatApi#frontendLiveChatShowMessage");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Chat ID
String *messageId = messageId_example; // Chat message ID
String *organisation = organisation_example; // 
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *bot = bot_example; //  (optional)
String *fields = fields_example; //  (optional)
String *userAgent = userAgent_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)

FrontendLiveChatApi *apiInstance = [[FrontendLiveChatApi alloc] init];

// show_message frontend_live_chat
[apiInstance frontendLiveChatShowMessageWith:id
    messageId:messageId
    organisation:organisation
    acceptLanguage:acceptLanguage
    bot:bot
    fields:fields
    userAgent:userAgent
    xForwardedFor:xForwardedFor
              completionHandler: ^(Live_chat_message output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendLiveChatApi()

var id = id_example; // {String} Chat ID

var messageId = messageId_example; // {String} Chat message ID

var organisation = organisation_example; // {String} 

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'bot': bot_example, // {String} 
  'fields': fields_example, // {String} 
  'userAgent': userAgent_example, // {String} 
  'xForwardedFor': xForwardedFor_example // {String} 
};
api.frontendLiveChatShowMessage(id, messageId, organisation, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendLiveChatShowMessageExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendLiveChatApi();
            var id = id_example;  // String | Chat ID
            var messageId = messageId_example;  // String | Chat message ID
            var organisation = organisation_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var bot = bot_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 
            var userAgent = userAgent_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 

            try
            {
                // show_message frontend_live_chat
                Live_chat_message result = apiInstance.frontendLiveChatShowMessage(id, messageId, organisation, acceptLanguage, bot, fields, userAgent, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendLiveChatApi.frontendLiveChatShowMessage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendLiveChatApi();
$id = id_example; // String | Chat ID
$messageId = messageId_example; // String | Chat message ID
$organisation = organisation_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | 
$bot = bot_example; // String | 
$fields = fields_example; // String | 
$userAgent = userAgent_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 

try {
    $result = $api_instance->frontendLiveChatShowMessage($id, $messageId, $organisation, $acceptLanguage, $bot, $fields, $userAgent, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FrontendLiveChatApi->frontendLiveChatShowMessage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendLiveChatApi;

my $api_instance = WWW::SwaggerClient::FrontendLiveChatApi->new();
my $id = id_example; # String | Chat ID
my $messageId = messageId_example; # String | Chat message ID
my $organisation = organisation_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | 
my $bot = bot_example; # String | 
my $fields = fields_example; # String | 
my $userAgent = userAgent_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 

eval { 
    my $result = $api_instance->frontendLiveChatShowMessage(id => $id, messageId => $messageId, organisation => $organisation, acceptLanguage => $acceptLanguage, bot => $bot, fields => $fields, userAgent => $userAgent, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FrontendLiveChatApi->frontendLiveChatShowMessage: $@\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.FrontendLiveChatApi()
id = id_example # String | Chat ID
messageId = messageId_example # String | Chat message ID
organisation = organisation_example # String | 
acceptLanguage = acceptLanguage_example # String |  (optional)
bot = bot_example # String |  (optional)
fields = fields_example # String |  (optional)
userAgent = userAgent_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)

try: 
    # show_message frontend_live_chat
    api_response = api_instance.frontend_live_chat_show_message(id, messageId, organisation, acceptLanguage=acceptLanguage, bot=bot, fields=fields, userAgent=userAgent, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FrontendLiveChatApi->frontendLiveChatShowMessage: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Chat ID
Required
message_id*
String
Chat message ID
Required
Header parameters
Name Description
Accept-Language
String
Bot
String
Fields
String
Organisation*
String
Required
User-Agent
String
X-Forwarded-For
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not Found


FrontendMail

frontendMailMessage

message frontend_mail

Receive message events webhook.


/0.0.1/frontend/mail/message

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/frontend/mail/message"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrontendMailApi;

import java.io.File;
import java.util.*;

public class FrontendMailApiExample {

    public static void main(String[] args) {
        
        FrontendMailApi apiInstance = new FrontendMailApi();
        MailPayload payload = ; // MailPayload | Mail payload
        try {
            apiInstance.frontendMailMessage(payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendMailApi#frontendMailMessage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrontendMailApi;

public class FrontendMailApiExample {

    public static void main(String[] args) {
        FrontendMailApi apiInstance = new FrontendMailApi();
        MailPayload payload = ; // MailPayload | Mail payload
        try {
            apiInstance.frontendMailMessage(payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontendMailApi#frontendMailMessage");
            e.printStackTrace();
        }
    }
}
MailPayload *payload = ; // Mail payload

FrontendMailApi *apiInstance = [[FrontendMailApi alloc] init];

// message frontend_mail
[apiInstance frontendMailMessageWith:payload
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.FrontendMailApi()

var payload = ; // {MailPayload} Mail payload

api.frontendMailMessage(payload).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class frontendMailMessageExample
    {
        public void main()
        {
            
            var apiInstance = new FrontendMailApi();
            var payload = new MailPayload(); // MailPayload | Mail payload

            try
            {
                // message frontend_mail
                apiInstance.frontendMailMessage(payload);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrontendMailApi.frontendMailMessage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FrontendMailApi();
$payload = ; // MailPayload | Mail payload

try {
    $api_instance->frontendMailMessage($payload);
} catch (Exception $e) {
    echo 'Exception when calling FrontendMailApi->frontendMailMessage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FrontendMailApi;

my $api_instance = WWW::SwaggerClient::FrontendMailApi->new();
my $payload = WWW::SwaggerClient::Object::MailPayload->new(); # MailPayload | Mail payload

eval { 
    $api_instance->frontendMailMessage(payload => $payload);
};
if ($@) {
    warn "Exception when calling FrontendMailApi->frontendMailMessage: $@\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.FrontendMailApi()
payload =  # MailPayload | Mail payload

try: 
    # message frontend_mail
    api_instance.frontend_mail_message(payload)
except ApiException as e:
    print("Exception when calling FrontendMailApi->frontendMailMessage: %s\n" % e)

Parameters

Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 404 - Not Found


Health

healthHealth

health health

Perform health check.


/_healthcheck

Usage and SDK Samples

curl -X GET "https://api.quriobot.com/_healthcheck"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HealthApi;

import java.io.File;
import java.util.*;

public class HealthApiExample {

    public static void main(String[] args) {
        
        HealthApi apiInstance = new HealthApi();
        try {
            apiInstance.healthHealth();
        } catch (ApiException e) {
            System.err.println("Exception when calling HealthApi#healthHealth");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HealthApi;

public class HealthApiExample {

    public static void main(String[] args) {
        HealthApi apiInstance = new HealthApi();
        try {
            apiInstance.healthHealth();
        } catch (ApiException e) {
            System.err.println("Exception when calling HealthApi#healthHealth");
            e.printStackTrace();
        }
    }
}

HealthApi *apiInstance = [[HealthApi alloc] init];

// health health
[apiInstance healthHealthWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.HealthApi()
api.healthHealth().then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class healthHealthExample
    {
        public void main()
        {
            
            var apiInstance = new HealthApi();

            try
            {
                // health health
                apiInstance.healthHealth();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HealthApi.healthHealth: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\HealthApi();

try {
    $api_instance->healthHealth();
} catch (Exception $e) {
    echo 'Exception when calling HealthApi->healthHealth: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HealthApi;

my $api_instance = WWW::SwaggerClient::HealthApi->new();

eval { 
    $api_instance->healthHealth();
};
if ($@) {
    warn "Exception when calling HealthApi->healthHealth: $@\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.HealthApi()

try: 
    # health health
    api_instance.health_health()
except ApiException as e:
    print("Exception when calling HealthApi->healthHealth: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 503 - Service Unavailable


QuriobotResponses

quriobotResponsesCreate

create quriobot_responses

Create response


/0.0.1/quriobot/responses

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/quriobot/responses"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QuriobotResponsesApi;

import java.io.File;
import java.util.*;

public class QuriobotResponsesApiExample {

    public static void main(String[] args) {
        
        QuriobotResponsesApi apiInstance = new QuriobotResponsesApi();
        ResponseCreatePayload payload = ; // ResponseCreatePayload | Response create payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        String xUserAgent = xUserAgent_example; // String | 
        try {
            apiInstance.quriobotResponsesCreate(payload, acceptLanguage, xForwardedFor, xUserAgent);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuriobotResponsesApi#quriobotResponsesCreate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QuriobotResponsesApi;

public class QuriobotResponsesApiExample {

    public static void main(String[] args) {
        QuriobotResponsesApi apiInstance = new QuriobotResponsesApi();
        ResponseCreatePayload payload = ; // ResponseCreatePayload | Response create payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        String xUserAgent = xUserAgent_example; // String | 
        try {
            apiInstance.quriobotResponsesCreate(payload, acceptLanguage, xForwardedFor, xUserAgent);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuriobotResponsesApi#quriobotResponsesCreate");
            e.printStackTrace();
        }
    }
}
ResponseCreatePayload *payload = ; // Response create payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)
String *xUserAgent = xUserAgent_example; //  (optional)

QuriobotResponsesApi *apiInstance = [[QuriobotResponsesApi alloc] init];

// create quriobot_responses
[apiInstance quriobotResponsesCreateWith:payload
    acceptLanguage:acceptLanguage
    xForwardedFor:xForwardedFor
    xUserAgent:xUserAgent
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.QuriobotResponsesApi()

var payload = ; // {ResponseCreatePayload} Response create payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'xForwardedFor': xForwardedFor_example, // {String} 
  'xUserAgent': xUserAgent_example // {String} 
};
api.quriobotResponsesCreate(payload, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class quriobotResponsesCreateExample
    {
        public void main()
        {
            
            var apiInstance = new QuriobotResponsesApi();
            var payload = new ResponseCreatePayload(); // ResponseCreatePayload | Response create payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 
            var xUserAgent = xUserAgent_example;  // String |  (optional) 

            try
            {
                // create quriobot_responses
                apiInstance.quriobotResponsesCreate(payload, acceptLanguage, xForwardedFor, xUserAgent);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QuriobotResponsesApi.quriobotResponsesCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\QuriobotResponsesApi();
$payload = ; // ResponseCreatePayload | Response create payload
$acceptLanguage = acceptLanguage_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 
$xUserAgent = xUserAgent_example; // String | 

try {
    $api_instance->quriobotResponsesCreate($payload, $acceptLanguage, $xForwardedFor, $xUserAgent);
} catch (Exception $e) {
    echo 'Exception when calling QuriobotResponsesApi->quriobotResponsesCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QuriobotResponsesApi;

my $api_instance = WWW::SwaggerClient::QuriobotResponsesApi->new();
my $payload = WWW::SwaggerClient::Object::ResponseCreatePayload->new(); # ResponseCreatePayload | Response create payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 
my $xUserAgent = xUserAgent_example; # String | 

eval { 
    $api_instance->quriobotResponsesCreate(payload => $payload, acceptLanguage => $acceptLanguage, xForwardedFor => $xForwardedFor, xUserAgent => $xUserAgent);
};
if ($@) {
    warn "Exception when calling QuriobotResponsesApi->quriobotResponsesCreate: $@\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.QuriobotResponsesApi()
payload =  # ResponseCreatePayload | Response create payload
acceptLanguage = acceptLanguage_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)
xUserAgent = xUserAgent_example # String |  (optional)

try: 
    # create quriobot_responses
    api_instance.quriobot_responses_create(payload, acceptLanguage=acceptLanguage, xForwardedFor=xForwardedFor, xUserAgent=xUserAgent)
except ApiException as e:
    print("Exception when calling QuriobotResponsesApi->quriobotResponsesCreate: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
X-Forwarded-For
String
X-User-Agent
String
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden


quriobotResponsesCreateUpload

create_upload quriobot_responses

Create file upload


/0.0.1/quriobot/responses/{id}/upload/{stepID}

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/quriobot/responses/{id}/upload/{stepID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QuriobotResponsesApi;

import java.io.File;
import java.util.*;

public class QuriobotResponsesApiExample {

    public static void main(String[] args) {
        
        QuriobotResponsesApi apiInstance = new QuriobotResponsesApi();
        String id = id_example; // String | Response id
        String stepID = stepID_example; // String | Step id
        ResponseUploadPayload payload = ; // ResponseUploadPayload | Response upload payload
        try {
            Bot_response_upload result = apiInstance.quriobotResponsesCreateUpload(id, stepID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuriobotResponsesApi#quriobotResponsesCreateUpload");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QuriobotResponsesApi;

public class QuriobotResponsesApiExample {

    public static void main(String[] args) {
        QuriobotResponsesApi apiInstance = new QuriobotResponsesApi();
        String id = id_example; // String | Response id
        String stepID = stepID_example; // String | Step id
        ResponseUploadPayload payload = ; // ResponseUploadPayload | Response upload payload
        try {
            Bot_response_upload result = apiInstance.quriobotResponsesCreateUpload(id, stepID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuriobotResponsesApi#quriobotResponsesCreateUpload");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Response id
String *stepID = stepID_example; // Step id
ResponseUploadPayload *payload = ; // Response upload payload

QuriobotResponsesApi *apiInstance = [[QuriobotResponsesApi alloc] init];

// create_upload quriobot_responses
[apiInstance quriobotResponsesCreateUploadWith:id
    stepID:stepID
    payload:payload
              completionHandler: ^(Bot_response_upload output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.QuriobotResponsesApi()

var id = id_example; // {String} Response id

var stepID = stepID_example; // {String} Step id

var payload = ; // {ResponseUploadPayload} Response upload payload

api.quriobotResponsesCreateUpload(id, stepID, payload).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class quriobotResponsesCreateUploadExample
    {
        public void main()
        {
            
            var apiInstance = new QuriobotResponsesApi();
            var id = id_example;  // String | Response id
            var stepID = stepID_example;  // String | Step id
            var payload = new ResponseUploadPayload(); // ResponseUploadPayload | Response upload payload

            try
            {
                // create_upload quriobot_responses
                Bot_response_upload result = apiInstance.quriobotResponsesCreateUpload(id, stepID, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QuriobotResponsesApi.quriobotResponsesCreateUpload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\QuriobotResponsesApi();
$id = id_example; // String | Response id
$stepID = stepID_example; // String | Step id
$payload = ; // ResponseUploadPayload | Response upload payload

try {
    $result = $api_instance->quriobotResponsesCreateUpload($id, $stepID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QuriobotResponsesApi->quriobotResponsesCreateUpload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QuriobotResponsesApi;

my $api_instance = WWW::SwaggerClient::QuriobotResponsesApi->new();
my $id = id_example; # String | Response id
my $stepID = stepID_example; # String | Step id
my $payload = WWW::SwaggerClient::Object::ResponseUploadPayload->new(); # ResponseUploadPayload | Response upload payload

eval { 
    my $result = $api_instance->quriobotResponsesCreateUpload(id => $id, stepID => $stepID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QuriobotResponsesApi->quriobotResponsesCreateUpload: $@\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.QuriobotResponsesApi()
id = id_example # String | Response id
stepID = stepID_example # String | Step id
payload =  # ResponseUploadPayload | Response upload payload

try: 
    # create_upload quriobot_responses
    api_response = api_instance.quriobot_responses_create_upload(id, stepID, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QuriobotResponsesApi->quriobotResponsesCreateUpload: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Response id
Required
stepID*
String
Step id
Required
Body parameters
Name Description
payload *

Responses

Status: 201 - Object created

Status: 400 - Bad Request

Status: 404 - Not Found


quriobotResponsesUpdate

update quriobot_responses

Update response


/0.0.1/quriobot/responses/{id}

Usage and SDK Samples

curl -X PATCH "https://api.quriobot.com/0.0.1/quriobot/responses/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QuriobotResponsesApi;

import java.io.File;
import java.util.*;

public class QuriobotResponsesApiExample {

    public static void main(String[] args) {
        
        QuriobotResponsesApi apiInstance = new QuriobotResponsesApi();
        String id = id_example; // String | Response id
        ResponseCreatePayload payload = ; // ResponseCreatePayload | Response create payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        String xUserAgent = xUserAgent_example; // String | 
        try {
            apiInstance.quriobotResponsesUpdate(id, payload, acceptLanguage, xForwardedFor, xUserAgent);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuriobotResponsesApi#quriobotResponsesUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QuriobotResponsesApi;

public class QuriobotResponsesApiExample {

    public static void main(String[] args) {
        QuriobotResponsesApi apiInstance = new QuriobotResponsesApi();
        String id = id_example; // String | Response id
        ResponseCreatePayload payload = ; // ResponseCreatePayload | Response create payload
        String acceptLanguage = acceptLanguage_example; // String | 
        String xForwardedFor = xForwardedFor_example; // String | 
        String xUserAgent = xUserAgent_example; // String | 
        try {
            apiInstance.quriobotResponsesUpdate(id, payload, acceptLanguage, xForwardedFor, xUserAgent);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuriobotResponsesApi#quriobotResponsesUpdate");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Response id
ResponseCreatePayload *payload = ; // Response create payload
String *acceptLanguage = acceptLanguage_example; //  (optional)
String *xForwardedFor = xForwardedFor_example; //  (optional)
String *xUserAgent = xUserAgent_example; //  (optional)

QuriobotResponsesApi *apiInstance = [[QuriobotResponsesApi alloc] init];

// update quriobot_responses
[apiInstance quriobotResponsesUpdateWith:id
    payload:payload
    acceptLanguage:acceptLanguage
    xForwardedFor:xForwardedFor
    xUserAgent:xUserAgent
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.QuriobotResponsesApi()

var id = id_example; // {String} Response id

var payload = ; // {ResponseCreatePayload} Response create payload

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} 
  'xForwardedFor': xForwardedFor_example, // {String} 
  'xUserAgent': xUserAgent_example // {String} 
};
api.quriobotResponsesUpdate(id, payload, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class quriobotResponsesUpdateExample
    {
        public void main()
        {
            
            var apiInstance = new QuriobotResponsesApi();
            var id = id_example;  // String | Response id
            var payload = new ResponseCreatePayload(); // ResponseCreatePayload | Response create payload
            var acceptLanguage = acceptLanguage_example;  // String |  (optional) 
            var xForwardedFor = xForwardedFor_example;  // String |  (optional) 
            var xUserAgent = xUserAgent_example;  // String |  (optional) 

            try
            {
                // update quriobot_responses
                apiInstance.quriobotResponsesUpdate(id, payload, acceptLanguage, xForwardedFor, xUserAgent);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QuriobotResponsesApi.quriobotResponsesUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\QuriobotResponsesApi();
$id = id_example; // String | Response id
$payload = ; // ResponseCreatePayload | Response create payload
$acceptLanguage = acceptLanguage_example; // String | 
$xForwardedFor = xForwardedFor_example; // String | 
$xUserAgent = xUserAgent_example; // String | 

try {
    $api_instance->quriobotResponsesUpdate($id, $payload, $acceptLanguage, $xForwardedFor, $xUserAgent);
} catch (Exception $e) {
    echo 'Exception when calling QuriobotResponsesApi->quriobotResponsesUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QuriobotResponsesApi;

my $api_instance = WWW::SwaggerClient::QuriobotResponsesApi->new();
my $id = id_example; # String | Response id
my $payload = WWW::SwaggerClient::Object::ResponseCreatePayload->new(); # ResponseCreatePayload | Response create payload
my $acceptLanguage = acceptLanguage_example; # String | 
my $xForwardedFor = xForwardedFor_example; # String | 
my $xUserAgent = xUserAgent_example; # String | 

eval { 
    $api_instance->quriobotResponsesUpdate(id => $id, payload => $payload, acceptLanguage => $acceptLanguage, xForwardedFor => $xForwardedFor, xUserAgent => $xUserAgent);
};
if ($@) {
    warn "Exception when calling QuriobotResponsesApi->quriobotResponsesUpdate: $@\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.QuriobotResponsesApi()
id = id_example # String | Response id
payload =  # ResponseCreatePayload | Response create payload
acceptLanguage = acceptLanguage_example # String |  (optional)
xForwardedFor = xForwardedFor_example # String |  (optional)
xUserAgent = xUserAgent_example # String |  (optional)

try: 
    # update quriobot_responses
    api_instance.quriobot_responses_update(id, payload, acceptLanguage=acceptLanguage, xForwardedFor=xForwardedFor, xUserAgent=xUserAgent)
except ApiException as e:
    print("Exception when calling QuriobotResponsesApi->quriobotResponsesUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Response id
Required
Header parameters
Name Description
Accept-Language
String
X-Forwarded-For
String
X-User-Agent
String
Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 403 - Forbidden


QuriobotSes

quriobotSesCreate

create quriobot_ses

Create SES event


/0.0.1/quriobot/ses/events

Usage and SDK Samples

curl -X POST "https://api.quriobot.com/0.0.1/quriobot/ses/events"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QuriobotSesApi;

import java.io.File;
import java.util.*;

public class QuriobotSesApiExample {

    public static void main(String[] args) {
        
        QuriobotSesApi apiInstance = new QuriobotSesApi();
        SESNotification payload = ; // SESNotification | 
        try {
            apiInstance.quriobotSesCreate(payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuriobotSesApi#quriobotSesCreate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QuriobotSesApi;

public class QuriobotSesApiExample {

    public static void main(String[] args) {
        QuriobotSesApi apiInstance = new QuriobotSesApi();
        SESNotification payload = ; // SESNotification | 
        try {
            apiInstance.quriobotSesCreate(payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuriobotSesApi#quriobotSesCreate");
            e.printStackTrace();
        }
    }
}
SESNotification *payload = ; // 

QuriobotSesApi *apiInstance = [[QuriobotSesApi alloc] init];

// create quriobot_ses
[apiInstance quriobotSesCreateWith:payload
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.QuriobotSesApi()

var payload = ; // {SESNotification} 

api.quriobotSesCreate(payload).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class quriobotSesCreateExample
    {
        public void main()
        {
            
            var apiInstance = new QuriobotSesApi();
            var payload = new SESNotification(); // SESNotification | 

            try
            {
                // create quriobot_ses
                apiInstance.quriobotSesCreate(payload);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QuriobotSesApi.quriobotSesCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\QuriobotSesApi();
$payload = ; // SESNotification | 

try {
    $api_instance->quriobotSesCreate($payload);
} catch (Exception $e) {
    echo 'Exception when calling QuriobotSesApi->quriobotSesCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QuriobotSesApi;

my $api_instance = WWW::SwaggerClient::QuriobotSesApi->new();
my $payload = WWW::SwaggerClient::Object::SESNotification->new(); # SESNotification | 

eval { 
    $api_instance->quriobotSesCreate(payload => $payload);
};
if ($@) {
    warn "Exception when calling QuriobotSesApi->quriobotSesCreate: $@\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.QuriobotSesApi()
payload =  # SESNotification | 

try: 
    # create quriobot_ses
    api_instance.quriobot_ses_create(payload)
except ApiException as e:
    print("Exception when calling QuriobotSesApi->quriobotSesCreate: %s\n" % e)

Parameters

Body parameters
Name Description
payload *

Responses

Status: 204 - No Content

Status: 400 - Bad Request


WebsiteTerms

websiteTermsShow

show website_terms

Terms


/0.0.1/website/terms/{id}

Usage and SDK Samples

curl -X GET "https://api.quriobot.com/0.0.1/website/terms/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebsiteTermsApi;

import java.io.File;
import java.util.*;

public class WebsiteTermsApiExample {

    public static void main(String[] args) {
        
        WebsiteTermsApi apiInstance = new WebsiteTermsApi();
        String id = id_example; // String | Backoffice user registration ID
        try {
            Terms_file result = apiInstance.websiteTermsShow(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebsiteTermsApi#websiteTermsShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WebsiteTermsApi;

public class WebsiteTermsApiExample {

    public static void main(String[] args) {
        WebsiteTermsApi apiInstance = new WebsiteTermsApi();
        String id = id_example; // String | Backoffice user registration ID
        try {
            Terms_file result = apiInstance.websiteTermsShow(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebsiteTermsApi#websiteTermsShow");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Backoffice user registration ID

WebsiteTermsApi *apiInstance = [[WebsiteTermsApi alloc] init];

// show website_terms
[apiInstance websiteTermsShowWith:id
              completionHandler: ^(Terms_file output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var QuriobotApi = require('quriobot_api');

var api = new QuriobotApi.WebsiteTermsApi()

var id = id_example; // {String} Backoffice user registration ID

api.websiteTermsShow(id).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class websiteTermsShowExample
    {
        public void main()
        {
            
            var apiInstance = new WebsiteTermsApi();
            var id = id_example;  // String | Backoffice user registration ID

            try
            {
                // show website_terms
                Terms_file result = apiInstance.websiteTermsShow(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsiteTermsApi.websiteTermsShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\WebsiteTermsApi();
$id = id_example; // String | Backoffice user registration ID

try {
    $result = $api_instance->websiteTermsShow($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebsiteTermsApi->websiteTermsShow: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WebsiteTermsApi;

my $api_instance = WWW::SwaggerClient::WebsiteTermsApi->new();
my $id = id_example; # String | Backoffice user registration ID

eval { 
    my $result = $api_instance->websiteTermsShow(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebsiteTermsApi->websiteTermsShow: $@\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.WebsiteTermsApi()
id = id_example # String | Backoffice user registration ID

try: 
    # show website_terms
    api_response = api_instance.website_terms_show(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebsiteTermsApi->websiteTermsShow: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Backoffice user registration ID
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 404 - Not Found