EdgeTier API Document

Agents

getAgents

List agents.

Get a list of agents, paginated response.


/agents

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://api.edgetier.com/agents?limit=&cursor=&external_reference=&email=&order_by=&interaction_start_date_time=&interaction_end_date_time="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AgentsApi;

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

public class AgentsApiExample {

    public static void main(String[] args) {
        
        AgentsApi apiInstance = new AgentsApi();
        Integer limit = 56; // Integer | Number of results to return in each page.
        String cursor = cursor_example; // String | Pagination cursor.
        String externalReference = externalReference_example; // String | External reference.
        String email = email_example; // String | Agent email.
        String orderBy = orderBy_example; // String | How to order the results.
        Date interactionStartDateTime = 2013-10-20T19:20:30+01:00; // Date | Filter agents that have been active after this date.
        Date interactionEndDateTime = 2013-10-20T19:20:30+01:00; // Date | Filter agents that have been active before this date.
        try {
            GetAgents result = apiInstance.getAgents(limit, cursor, externalReference, email, orderBy, interactionStartDateTime, interactionEndDateTime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentsApi#getAgents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AgentsApi;

public class AgentsApiExample {

    public static void main(String[] args) {
        AgentsApi apiInstance = new AgentsApi();
        Integer limit = 56; // Integer | Number of results to return in each page.
        String cursor = cursor_example; // String | Pagination cursor.
        String externalReference = externalReference_example; // String | External reference.
        String email = email_example; // String | Agent email.
        String orderBy = orderBy_example; // String | How to order the results.
        Date interactionStartDateTime = 2013-10-20T19:20:30+01:00; // Date | Filter agents that have been active after this date.
        Date interactionEndDateTime = 2013-10-20T19:20:30+01:00; // Date | Filter agents that have been active before this date.
        try {
            GetAgents result = apiInstance.getAgents(limit, cursor, externalReference, email, orderBy, interactionStartDateTime, interactionEndDateTime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentsApi#getAgents");
            e.printStackTrace();
        }
    }
}
Integer *limit = 56; // Number of results to return in each page. (optional) (default to 10)
String *cursor = cursor_example; // Pagination cursor. (optional)
String *externalReference = externalReference_example; // External reference. (optional)
String *email = email_example; // Agent email. (optional)
String *orderBy = orderBy_example; // How to order the results. (optional) (default to email.asc)
Date *interactionStartDateTime = 2013-10-20T19:20:30+01:00; // Filter agents that have been active after this date. (optional)
Date *interactionEndDateTime = 2013-10-20T19:20:30+01:00; // Filter agents that have been active before this date. (optional)

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

// List agents.
[apiInstance getAgentsWith:limit
    cursor:cursor
    externalReference:externalReference
    email:email
    orderBy:orderBy
    interactionStartDateTime:interactionStartDateTime
    interactionEndDateTime:interactionEndDateTime
              completionHandler: ^(GetAgents output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EdgeTierApiDocument = require('edge_tier_api_document');

var api = new EdgeTierApiDocument.AgentsApi()
var opts = { 
  'limit': 56, // {{Integer}} Number of results to return in each page.
  'cursor': cursor_example, // {{String}} Pagination cursor.
  'externalReference': externalReference_example, // {{String}} External reference.
  'email': email_example, // {{String}} Agent email.
  'orderBy': orderBy_example, // {{String}} How to order the results.
  'interactionStartDateTime': 2013-10-20T19:20:30+01:00, // {{Date}} Filter agents that have been active after this date.
  'interactionEndDateTime': 2013-10-20T19:20:30+01:00 // {{Date}} Filter agents that have been active before this date.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAgents(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AgentsApi();
            var limit = 56;  // Integer | Number of results to return in each page. (optional)  (default to 10)
            var cursor = cursor_example;  // String | Pagination cursor. (optional) 
            var externalReference = externalReference_example;  // String | External reference. (optional) 
            var email = email_example;  // String | Agent email. (optional) 
            var orderBy = orderBy_example;  // String | How to order the results. (optional)  (default to email.asc)
            var interactionStartDateTime = 2013-10-20T19:20:30+01:00;  // Date | Filter agents that have been active after this date. (optional) 
            var interactionEndDateTime = 2013-10-20T19:20:30+01:00;  // Date | Filter agents that have been active before this date. (optional) 

            try
            {
                // List agents.
                GetAgents result = apiInstance.getAgents(limit, cursor, externalReference, email, orderBy, interactionStartDateTime, interactionEndDateTime);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgentsApi.getAgents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAgentsApi();
$limit = 56; // Integer | Number of results to return in each page.
$cursor = cursor_example; // String | Pagination cursor.
$externalReference = externalReference_example; // String | External reference.
$email = email_example; // String | Agent email.
$orderBy = orderBy_example; // String | How to order the results.
$interactionStartDateTime = 2013-10-20T19:20:30+01:00; // Date | Filter agents that have been active after this date.
$interactionEndDateTime = 2013-10-20T19:20:30+01:00; // Date | Filter agents that have been active before this date.

try {
    $result = $api_instance->getAgents($limit, $cursor, $externalReference, $email, $orderBy, $interactionStartDateTime, $interactionEndDateTime);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AgentsApi->getAgents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AgentsApi;

my $api_instance = WWW::SwaggerClient::AgentsApi->new();
my $limit = 56; # Integer | Number of results to return in each page.
my $cursor = cursor_example; # String | Pagination cursor.
my $externalReference = externalReference_example; # String | External reference.
my $email = email_example; # String | Agent email.
my $orderBy = orderBy_example; # String | How to order the results.
my $interactionStartDateTime = 2013-10-20T19:20:30+01:00; # Date | Filter agents that have been active after this date.
my $interactionEndDateTime = 2013-10-20T19:20:30+01:00; # Date | Filter agents that have been active before this date.

eval { 
    my $result = $api_instance->getAgents(limit => $limit, cursor => $cursor, externalReference => $externalReference, email => $email, orderBy => $orderBy, interactionStartDateTime => $interactionStartDateTime, interactionEndDateTime => $interactionEndDateTime);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgentsApi->getAgents: $@\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.AgentsApi()
limit = 56 # Integer | Number of results to return in each page. (optional) (default to 10)
cursor = cursor_example # String | Pagination cursor. (optional)
externalReference = externalReference_example # String | External reference. (optional)
email = email_example # String | Agent email. (optional)
orderBy = orderBy_example # String | How to order the results. (optional) (default to email.asc)
interactionStartDateTime = 2013-10-20T19:20:30+01:00 # Date | Filter agents that have been active after this date. (optional)
interactionEndDateTime = 2013-10-20T19:20:30+01:00 # Date | Filter agents that have been active before this date. (optional)

try: 
    # List agents.
    api_response = api_instance.get_agents(limit=limit, cursor=cursor, externalReference=externalReference, email=email, orderBy=orderBy, interactionStartDateTime=interactionStartDateTime, interactionEndDateTime=interactionEndDateTime)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgentsApi->getAgents: %s\n" % e)

Parameters

Query parameters
Name Description
limit
Integer
Number of results to return in each page.
cursor
String
Pagination cursor.
external_reference
String
External reference.
email
String
Agent email.
order_by
String
How to order the results.
interaction_start_date_time
Date (date-time)
Filter agents that have been active after this date.
interaction_end_date_time
Date (date-time)
Filter agents that have been active before this date.

Responses

Status: 200 - Successful Response


postAgents

Store an agent.

Store an agent.


/agents

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://api.edgetier.com/agents"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AgentsApi;

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

public class AgentsApiExample {

    public static void main(String[] args) {
        
        AgentsApi apiInstance = new AgentsApi();
        PostAgentSchema body = ; // PostAgentSchema | 
        try {
            Agent result = apiInstance.postAgents(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentsApi#postAgents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AgentsApi;

public class AgentsApiExample {

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

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

// Store an agent.
[apiInstance postAgentsWith:body
              completionHandler: ^(Agent output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EdgeTierApiDocument = require('edge_tier_api_document');

var api = new EdgeTierApiDocument.AgentsApi()
var body = ; // {{PostAgentSchema}} 

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

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

            var apiInstance = new AgentsApi();
            var body = new PostAgentSchema(); // PostAgentSchema | 

            try
            {
                // Store an agent.
                Agent result = apiInstance.postAgents(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgentsApi.postAgents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAgentsApi();
$body = ; // PostAgentSchema | 

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

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

eval { 
    my $result = $api_instance->postAgents(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgentsApi->postAgents: $@\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.AgentsApi()
body =  # PostAgentSchema | 

try: 
    # Store an agent.
    api_response = api_instance.post_agents(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgentsApi->postAgents: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Successful Response


Authentication

postOauth2Token

Obtain a token.

Authenticate to exchange credentials for a token.


/oauth2/token

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
"https://api.edgetier.com/oauth2/token?client_id=&client_secret=&grant_type="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthenticationApi;

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

public class AuthenticationApiExample {

    public static void main(String[] args) {
        
        AuthenticationApi apiInstance = new AuthenticationApi();
        String clientId = clientId_example; // String | 
        String clientSecret = clientSecret_example; // String | 
        String grantType = grantType_example; // String | 
        try {
            Token result = apiInstance.postOauth2Token(clientId, clientSecret, grantType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#postOauth2Token");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthenticationApi;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        AuthenticationApi apiInstance = new AuthenticationApi();
        String clientId = clientId_example; // String | 
        String clientSecret = clientSecret_example; // String | 
        String grantType = grantType_example; // String | 
        try {
            Token result = apiInstance.postOauth2Token(clientId, clientSecret, grantType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#postOauth2Token");
            e.printStackTrace();
        }
    }
}
String *clientId = clientId_example; // 
String *clientSecret = clientSecret_example; // 
String *grantType = grantType_example; // 

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

// Obtain a token.
[apiInstance postOauth2TokenWith:clientId
    clientSecret:clientSecret
    grantType:grantType
              completionHandler: ^(Token output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EdgeTierApiDocument = require('edge_tier_api_document');

var api = new EdgeTierApiDocument.AuthenticationApi()
var clientId = clientId_example; // {{String}} 
var clientSecret = clientSecret_example; // {{String}} 
var grantType = grantType_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postOauth2Token(clientId, clientSecret, grantType, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AuthenticationApi();
            var clientId = clientId_example;  // String | 
            var clientSecret = clientSecret_example;  // String | 
            var grantType = grantType_example;  // String | 

            try
            {
                // Obtain a token.
                Token result = apiInstance.postOauth2Token(clientId, clientSecret, grantType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthenticationApi.postOauth2Token: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAuthenticationApi();
$clientId = clientId_example; // String | 
$clientSecret = clientSecret_example; // String | 
$grantType = grantType_example; // String | 

try {
    $result = $api_instance->postOauth2Token($clientId, $clientSecret, $grantType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->postOauth2Token: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthenticationApi;

my $api_instance = WWW::SwaggerClient::AuthenticationApi->new();
my $clientId = clientId_example; # String | 
my $clientSecret = clientSecret_example; # String | 
my $grantType = grantType_example; # String | 

eval { 
    my $result = $api_instance->postOauth2Token(clientId => $clientId, clientSecret => $clientSecret, grantType => $grantType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthenticationApi->postOauth2Token: $@\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.AuthenticationApi()
clientId = clientId_example # String | 
clientSecret = clientSecret_example # String | 
grantType = grantType_example # String | 

try: 
    # Obtain a token.
    api_response = api_instance.post_oauth2_token(clientId, clientSecret, grantType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->postOauth2Token: %s\n" % e)

Parameters

Query parameters
Name Description
client_id*
String
Required
client_secret*
String
Required
grant_type*
String
Required

Responses

Status: 200 - Successful Response


InteractionVariables

getInteractionVariables

List variable interactions.

Get a detailed response of variable interactions.


/interactions/variables

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://api.edgetier.com/interactions/variables?interaction_variable="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InteractionVariablesApi;

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

public class InteractionVariablesApiExample {

    public static void main(String[] args) {
        
        InteractionVariablesApi apiInstance = new InteractionVariablesApi();
        String interactionVariable = interactionVariable_example; // String | Interaction variable to search.
        try {
            GetInteractionVariables result = apiInstance.getInteractionVariables(interactionVariable);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InteractionVariablesApi#getInteractionVariables");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InteractionVariablesApi;

public class InteractionVariablesApiExample {

    public static void main(String[] args) {
        InteractionVariablesApi apiInstance = new InteractionVariablesApi();
        String interactionVariable = interactionVariable_example; // String | Interaction variable to search.
        try {
            GetInteractionVariables result = apiInstance.getInteractionVariables(interactionVariable);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InteractionVariablesApi#getInteractionVariables");
            e.printStackTrace();
        }
    }
}
String *interactionVariable = interactionVariable_example; // Interaction variable to search. (optional)

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

// List variable interactions.
[apiInstance getInteractionVariablesWith:interactionVariable
              completionHandler: ^(GetInteractionVariables output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EdgeTierApiDocument = require('edge_tier_api_document');

var api = new EdgeTierApiDocument.InteractionVariablesApi()
var opts = { 
  'interactionVariable': interactionVariable_example // {{String}} Interaction variable to search.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInteractionVariables(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new InteractionVariablesApi();
            var interactionVariable = interactionVariable_example;  // String | Interaction variable to search. (optional) 

            try
            {
                // List variable interactions.
                GetInteractionVariables result = apiInstance.getInteractionVariables(interactionVariable);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InteractionVariablesApi.getInteractionVariables: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiInteractionVariablesApi();
$interactionVariable = interactionVariable_example; // String | Interaction variable to search.

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

my $api_instance = WWW::SwaggerClient::InteractionVariablesApi->new();
my $interactionVariable = interactionVariable_example; # String | Interaction variable to search.

eval { 
    my $result = $api_instance->getInteractionVariables(interactionVariable => $interactionVariable);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InteractionVariablesApi->getInteractionVariables: $@\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.InteractionVariablesApi()
interactionVariable = interactionVariable_example # String | Interaction variable to search. (optional)

try: 
    # List variable interactions.
    api_response = api_instance.get_interaction_variables(interactionVariable=interactionVariable)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InteractionVariablesApi->getInteractionVariables: %s\n" % e)

Parameters

Query parameters
Name Description
interaction_variable
String
Interaction variable to search.

Responses

Status: 200 - Successful Response


postInteractionVariables

Store an interaction variable.

Store an interaction variable.


/interactions/variables

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://api.edgetier.com/interactions/variables"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InteractionVariablesApi;

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

public class InteractionVariablesApiExample {

    public static void main(String[] args) {
        
        InteractionVariablesApi apiInstance = new InteractionVariablesApi();
        PostInteractionVariableSchema body = ; // PostInteractionVariableSchema | 
        try {
            InteractionVariable result = apiInstance.postInteractionVariables(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InteractionVariablesApi#postInteractionVariables");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InteractionVariablesApi;

public class InteractionVariablesApiExample {

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

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

// Store an interaction variable.
[apiInstance postInteractionVariablesWith:body
              completionHandler: ^(InteractionVariable output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EdgeTierApiDocument = require('edge_tier_api_document');

var api = new EdgeTierApiDocument.InteractionVariablesApi()
var body = ; // {{PostInteractionVariableSchema}} 

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

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

            var apiInstance = new InteractionVariablesApi();
            var body = new PostInteractionVariableSchema(); // PostInteractionVariableSchema | 

            try
            {
                // Store an interaction variable.
                InteractionVariable result = apiInstance.postInteractionVariables(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InteractionVariablesApi.postInteractionVariables: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiInteractionVariablesApi();
$body = ; // PostInteractionVariableSchema | 

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

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

eval { 
    my $result = $api_instance->postInteractionVariables(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InteractionVariablesApi->postInteractionVariables: $@\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.InteractionVariablesApi()
body =  # PostInteractionVariableSchema | 

try: 
    # Store an interaction variable.
    api_response = api_instance.post_interaction_variables(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InteractionVariablesApi->postInteractionVariables: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Successful Response


Interactions

patchInteraction

Update an interaction.

Update an interaction.


/interactions/{interaction_id}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://api.edgetier.com/interactions/{interaction_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InteractionsApi;

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

public class InteractionsApiExample {

    public static void main(String[] args) {
        
        InteractionsApi apiInstance = new InteractionsApi();
        PatchInteractionSchema body = ; // PatchInteractionSchema | 
        String interactionId = interactionId_example; // String | ID for the interaction to update.
        try {
            Interaction result = apiInstance.patchInteraction(body, interactionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InteractionsApi#patchInteraction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InteractionsApi;

public class InteractionsApiExample {

    public static void main(String[] args) {
        InteractionsApi apiInstance = new InteractionsApi();
        PatchInteractionSchema body = ; // PatchInteractionSchema | 
        String interactionId = interactionId_example; // String | ID for the interaction to update.
        try {
            Interaction result = apiInstance.patchInteraction(body, interactionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InteractionsApi#patchInteraction");
            e.printStackTrace();
        }
    }
}
PatchInteractionSchema *body = ; // 
String *interactionId = interactionId_example; // ID for the interaction to update.

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

// Update an interaction.
[apiInstance patchInteractionWith:body
    interactionId:interactionId
              completionHandler: ^(Interaction output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EdgeTierApiDocument = require('edge_tier_api_document');

var api = new EdgeTierApiDocument.InteractionsApi()
var body = ; // {{PatchInteractionSchema}} 
var interactionId = interactionId_example; // {{String}} ID for the interaction to update.

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

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

            var apiInstance = new InteractionsApi();
            var body = new PatchInteractionSchema(); // PatchInteractionSchema | 
            var interactionId = interactionId_example;  // String | ID for the interaction to update.

            try
            {
                // Update an interaction.
                Interaction result = apiInstance.patchInteraction(body, interactionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InteractionsApi.patchInteraction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiInteractionsApi();
$body = ; // PatchInteractionSchema | 
$interactionId = interactionId_example; // String | ID for the interaction to update.

try {
    $result = $api_instance->patchInteraction($body, $interactionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InteractionsApi->patchInteraction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InteractionsApi;

my $api_instance = WWW::SwaggerClient::InteractionsApi->new();
my $body = WWW::SwaggerClient::Object::PatchInteractionSchema->new(); # PatchInteractionSchema | 
my $interactionId = interactionId_example; # String | ID for the interaction to update.

eval { 
    my $result = $api_instance->patchInteraction(body => $body, interactionId => $interactionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InteractionsApi->patchInteraction: $@\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.InteractionsApi()
body =  # PatchInteractionSchema | 
interactionId = interactionId_example # String | ID for the interaction to update.

try: 
    # Update an interaction.
    api_response = api_instance.patch_interaction(body, interactionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InteractionsApi->patchInteraction: %s\n" % e)

Parameters

Path parameters
Name Description
interaction_id*
String
ID for the interaction to update.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Successful Response


postInteraction

Store an interaction.

Store an interaction.


/interactions

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://api.edgetier.com/interactions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InteractionsApi;

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

public class InteractionsApiExample {

    public static void main(String[] args) {
        
        InteractionsApi apiInstance = new InteractionsApi();
        PostInteractionSchema body = ; // PostInteractionSchema | 
        try {
            Interaction result = apiInstance.postInteraction(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InteractionsApi#postInteraction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InteractionsApi;

public class InteractionsApiExample {

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

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

// Store an interaction.
[apiInstance postInteractionWith:body
              completionHandler: ^(Interaction output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EdgeTierApiDocument = require('edge_tier_api_document');

var api = new EdgeTierApiDocument.InteractionsApi()
var body = ; // {{PostInteractionSchema}} 

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

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

            var apiInstance = new InteractionsApi();
            var body = new PostInteractionSchema(); // PostInteractionSchema | 

            try
            {
                // Store an interaction.
                Interaction result = apiInstance.postInteraction(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InteractionsApi.postInteraction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiInteractionsApi();
$body = ; // PostInteractionSchema | 

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

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

eval { 
    my $result = $api_instance->postInteraction(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InteractionsApi->postInteraction: $@\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.InteractionsApi()
body =  # PostInteractionSchema | 

try: 
    # Store an interaction.
    api_response = api_instance.post_interaction(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InteractionsApi->postInteraction: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Successful Response