Skip to content

Files

Latest commit

 

History

History
236 lines (168 loc) · 8.84 KB

NotificationsApi.md

File metadata and controls

236 lines (168 loc) · 8.84 KB

Ageras\Api\NotificationsApi

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

Method HTTP request Description
notificationsActionsCreate POST /notifications/actions
notificationsActionsCreate_0 POST /notifications/{notification_id}/actions
notificationsGet GET /notifications/{notification_id}
notificationsIndex GET /notifications

notificationsActionsCreate

\Ageras\Api\NotificationResource notificationsActionsCreate($notification_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\NotificationsApi();
$notification_action_resource = new \Ageras\Api\NotificationActionResource(); // \Ageras\Api\NotificationActionResource | 

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

Parameters

Name Type Description Notes
notification_action_resource \Ageras\Api\NotificationActionResource

Return type

\Ageras\Api\NotificationResource

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]

notificationsActionsCreate_0

\Ageras\Api\NotificationResource notificationsActionsCreate_0($notification_id , $notification_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\NotificationsApi();
$notification_id = "notification_id_example"; // string | 
$notification_action_resource = new \Ageras\Api\NotificationActionResource(); // \Ageras\Api\NotificationActionResource | 

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

Parameters

Name Type Description Notes
notification_id string
notification_action_resource \Ageras\Api\NotificationActionResource

Return type

\Ageras\Api\NotificationResource

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]

notificationsGet

\Ageras\Api\NotificationResource notificationsGet($notification_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\NotificationsApi();
$notification_id = "notification_id_example"; // string | 

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

Parameters

Name Type Description Notes
notification_id string

Return type

\Ageras\Api\NotificationResource

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]

notificationsIndex

\Ageras\Api\NotificationResult notificationsIndex($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\NotificationsApi();
$criteria = [
        'geo_code' => "geo_code_example"; // string | Geo Code
        'sort' => "relevance"; // string | Sort notifications
        'created_after' => "created_after_example"; // string | Only show notifications created after a given date
        'partner_user_id' => "partner_user_id_example"; // string | Id's of the partner users to filter
        'client_id' => "client_id_example"; // string | Id's of the clients to filter
        'employee_id' => "employee_id_example"; // string | Id's of the employees to filter
        '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->notificationsIndex($criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotificationsApi->notificationsIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
geo_code string Geo Code [optional]
sort string Sort notifications [optional] [default to relevance]
created_after string Only show notifications created after a given date [optional]
partner_user_id string Id's of the partner users to filter [optional]
client_id string Id's of the clients to filter [optional]
employee_id string Id's of the employees to filter [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\NotificationResult

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]