Skip to content

Latest commit

 

History

History
242 lines (174 loc) · 8.02 KB

TermsApi.md

File metadata and controls

242 lines (174 loc) · 8.02 KB
Raw

Ageras\Api\TermsApi

All URIs are relative to https://api.ageras.com/v2

Method HTTP request Description
termsAcceptedIndex GET /terms/accepted
termsActionsCreate POST /terms/{terms_id}/actions
termsGet GET /terms/{terms_id}
termsIndex GET /terms

termsAcceptedIndex

\Ageras\Api\TermsResult termsAcceptedIndex($criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\TermsApi();
$criteria = [
        'acceptor_id' => 56; // int | 
        'acceptor_type' => "partner"; // string | 
        'terms_id' => "terms_id_example"; // string | 
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

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

Parameters

Name Type Description Notes
acceptor_id int [optional]
acceptor_type string [optional] [default to partner]
terms_id string [optional]
limit int The number of resources to be returned. [optional]
page int The page position in the result. [optional]
query string The search wildcard. [optional]

Return type

\Ageras\Api\TermsResult

Authorization

jwt, login

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

termsActionsCreate

\Ageras\Api\TermsActionResource termsActionsCreate($terms_id , $terms_action_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\TermsApi();
$terms_id = "terms_id_example"; // string | 
$terms_action_resource = new \Ageras\Api\TermsActionResource(); // \Ageras\Api\TermsActionResource | 

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

Parameters

Name Type Description Notes
terms_id string
terms_action_resource \Ageras\Api\TermsActionResource

Return type

\Ageras\Api\TermsActionResource

Authorization

jwt, login

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

termsGet

\Ageras\Api\TermsResource termsGet($terms_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\TermsApi();
$terms_id = "terms_id_example"; // string | 

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

Parameters

Name Type Description Notes
terms_id string

Return type

\Ageras\Api\TermsResource

Authorization

jwt, login

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

termsIndex

\Ageras\Api\TermsResult termsIndex($criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\TermsApi();
$criteria = [
        'geo_code' => "geo_code_example"; // string | 
        'type' => "type_example"; // string | 
        'identifier' => "identifier_example"; // string | 
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

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

Parameters

Name Type Description Notes
geo_code string [optional]
type string [optional]
identifier string [optional]
limit int The number of resources to be returned. [optional]
page int The page position in the result. [optional]
query string The search wildcard. [optional]

Return type

\Ageras\Api\TermsResult

Authorization

jwt, login

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]