AskNews\AlertsApi

All URIs are relative to https://api.asknews.app, except if the operation defines another base path.

Method	HTTP request	Description
createAlert()	POST /v1/chat/alerts	Create an alert
deleteAlert()	DELETE /v1/chat/alerts/{alert_id}	Delete an alert
getAlert()	GET /v1/chat/alerts/{alert_id}	Get an alert
getAlertLogs()	GET /v1/chat/alerts/{alert_id}/logs	Get alert logs
getAlerts()	GET /v1/chat/alerts	Get all created alerts
putAlert()	PUT /v1/chat/alerts/{alert_id}	Update an alert

`createAlert()`

createAlert($create_alert_request): \AskNews\Model\AlertResponse

Create an alert

Create an alert.

Example

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



// Configure sdk credentials
$config = new AskNews\Configuration([
  'clientId' => 'YOUR_ASKNEWS_CLIENT_ID',
  'clientSecret' => 'YOUR_ASKNEWS_CLIENT_SECRET',
  'scopes' => ['news', 'chat', 'stories', 'analytics']
]);


$apiInstance = new AskNews\Api\AlertsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$create_alert_request = new \AskNews\Model\CreateAlertRequest(); // \AskNews\Model\CreateAlertRequest

try {
    $result = $apiInstance->createAlert($create_alert_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertsApi->createAlert: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
create_alert_request	\AskNews\Model\CreateAlertRequest

Return type

\AskNews\Model\AlertResponse

Authorization

Bearer, Bearer

HTTP request headers

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

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

`deleteAlert()`

deleteAlert($alert_id)

Delete an alert

Delete an alert.

Example

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



// Configure sdk credentials
$config = new AskNews\Configuration([
  'clientId' => 'YOUR_ASKNEWS_CLIENT_ID',
  'clientSecret' => 'YOUR_ASKNEWS_CLIENT_SECRET',
  'scopes' => ['news', 'chat', 'stories', 'analytics']
]);


$apiInstance = new AskNews\Api\AlertsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$alert_id = 'alert_id_example'; // string | The alert ID

try {
    $apiInstance->deleteAlert($alert_id);
} catch (Exception $e) {
    echo 'Exception when calling AlertsApi->deleteAlert: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
alert_id	string	The alert ID

Return type

void (empty response body)

Authorization

Bearer, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getAlert()`

getAlert($alert_id): \AskNews\Model\AlertResponse

Get an alert

Get an alert.

Example

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



// Configure sdk credentials
$config = new AskNews\Configuration([
  'clientId' => 'YOUR_ASKNEWS_CLIENT_ID',
  'clientSecret' => 'YOUR_ASKNEWS_CLIENT_SECRET',
  'scopes' => ['news', 'chat', 'stories', 'analytics']
]);


$apiInstance = new AskNews\Api\AlertsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$alert_id = 'alert_id_example'; // string | The alert ID

try {
    $result = $apiInstance->getAlert($alert_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertsApi->getAlert: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
alert_id	string	The alert ID

Return type

\AskNews\Model\AlertResponse

Authorization

Bearer, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getAlertLogs()`

getAlertLogs($alert_id, $page, $per_page, $all): \AskNews\Model\PaginatedResponseAlertLog

Get alert logs

Get alert logs.

Example

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



// Configure sdk credentials
$config = new AskNews\Configuration([
  'clientId' => 'YOUR_ASKNEWS_CLIENT_ID',
  'clientSecret' => 'YOUR_ASKNEWS_CLIENT_SECRET',
  'scopes' => ['news', 'chat', 'stories', 'analytics']
]);


$apiInstance = new AskNews\Api\AlertsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$alert_id = 'alert_id_example'; // string | The alert ID
$page = 1; // int | The page number to get
$per_page = 10; // int | The number of items per page
$all = false; // bool | Whether to get all the alert logs

try {
    $result = $apiInstance->getAlertLogs($alert_id, $page, $per_page, $all);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertsApi->getAlertLogs: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
alert_id	string	The alert ID
page	int	The page number to get	[optional] [default to 1]
per_page	int	The number of items per page	[optional] [default to 10]
all	bool	Whether to get all the alert logs	[optional] [default to false]

Return type

\AskNews\Model\PaginatedResponseAlertLog

Authorization

Bearer, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getAlerts()`

getAlerts($page, $per_page, $all): \AskNews\Model\PaginatedResponseAlertResponse

Get all created alerts

Get all created alerts.

Example

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



// Configure sdk credentials
$config = new AskNews\Configuration([
  'clientId' => 'YOUR_ASKNEWS_CLIENT_ID',
  'clientSecret' => 'YOUR_ASKNEWS_CLIENT_SECRET',
  'scopes' => ['news', 'chat', 'stories', 'analytics']
]);


$apiInstance = new AskNews\Api\AlertsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$page = 1; // int | The page number to get
$per_page = 10; // int | The number of items per page
$all = false; // bool | Whether to get all the alerts

try {
    $result = $apiInstance->getAlerts($page, $per_page, $all);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertsApi->getAlerts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
page	int	The page number to get	[optional] [default to 1]
per_page	int	The number of items per page	[optional] [default to 10]
all	bool	Whether to get all the alerts	[optional] [default to false]

Return type

\AskNews\Model\PaginatedResponseAlertResponse

Authorization

Bearer, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`putAlert()`

putAlert($alert_id, $update_alert_request): \AskNews\Model\AlertResponse

Update an alert

Update an alert.

Example

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



// Configure sdk credentials
$config = new AskNews\Configuration([
  'clientId' => 'YOUR_ASKNEWS_CLIENT_ID',
  'clientSecret' => 'YOUR_ASKNEWS_CLIENT_SECRET',
  'scopes' => ['news', 'chat', 'stories', 'analytics']
]);


$apiInstance = new AskNews\Api\AlertsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$alert_id = 'alert_id_example'; // string | The alert ID
$update_alert_request = new \AskNews\Model\UpdateAlertRequest(); // \AskNews\Model\UpdateAlertRequest

try {
    $result = $apiInstance->putAlert($alert_id, $update_alert_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertsApi->putAlert: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
alert_id	string	The alert ID
update_alert_request	\AskNews\Model\UpdateAlertRequest

Return type

\AskNews\Model\AlertResponse

Authorization

Bearer, Bearer

HTTP request headers

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

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

Files

AlertsApi.md

Latest commit

History

AlertsApi.md

File metadata and controls

AskNews\AlertsApi

createAlert()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteAlert()

Example

Parameters

Return type

Authorization

HTTP request headers

getAlert()

Example

Parameters

Return type

Authorization

HTTP request headers

getAlertLogs()

Example

Parameters

Return type

Authorization

HTTP request headers

getAlerts()

Example

Parameters

Return type

Authorization

HTTP request headers

putAlert()

Example

Parameters

Return type

Authorization

HTTP request headers

`createAlert()`

`deleteAlert()`

`getAlert()`

`getAlertLogs()`

`getAlerts()`

`putAlert()`