Class AlertsClient

Interact with the Alert API

Class AlertsClient

APWG\API\AbstractClient implements APWG\API\ClientInterface

APWG\API\Alerts\AlertsClient

Namespace: APWG\API\Alerts
Package: APWG\API\Alerts
Copyright: Copyright (c) 2017 The Anti-Phishing Working Group
Author: Andrew Breksa andrew@apwg.org
Located at APWG/API/Alerts/AlertsClient.php

Methods summary

`public Psr\Http\Message\ResponseInterface`	# `search( array $options = [] )` Searches your Alerts Searches your Alerts Parameters `$options` an associative array of query parameters Returns Psr\Http\Message\ResponseInterface
`public Psr\Http\Message\ResponseInterface`	# `get( integer $id, array $options = [] )` Gets a specific Alert Gets a specific Alert Parameters `$id` the Alert id `$options` an associative array of query parameters Returns Psr\Http\Message\ResponseInterface
`public Psr\Http\Message\ResponseInterface`	# `create( array $data, array $options = [] )` Creates a new Alert Creates a new Alert Parameters `$data` an associative array of Alert data `$options` an associative array pf query parameters Returns Psr\Http\Message\ResponseInterface
`public Psr\Http\Message\ResponseInterface`	# `inactive( integer $id, $options = [] )` Updates an Alert to status: inactive Updates an Alert to status: inactive Parameters `$id` the Alert id `$options` Returns Psr\Http\Message\ResponseInterface
`public Psr\Http\Message\ResponseInterface`	# `patch( integer $id, array $data, $options = [] )` Updates an Alert Updates an Alert Parameters `$id` the Alert id `$data` `$options` Returns Psr\Http\Message\ResponseInterface
`public Psr\Http\Message\ResponseInterface`	# `active( integer $id, $options = [] )` Updates an Alert to status: active Updates an Alert to status: active Parameters `$id` the Alert id `$options` Returns Psr\Http\Message\ResponseInterface

Methods inherited from APWG\API\AbstractClient

__construct(), _call(), getApiKey(), getBaseUri(), getCache(), getClient(), getGlobalOptions(), getGuzzleOptions(), setApiKey(), setBaseUri(), setCache(), setClient(), setGlobalOptions(), setGuzzleOptions()

Properties summary

Properties inherited from APWG\API\AbstractClient

$apiKey, $base_uri, $cache, $client, $globalOptions, $guzzleOptions

Namespaces

Classes

Class AlertsClient

Methods summary

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Methods inherited from APWG\API\AbstractClient

Properties summary

Properties inherited from APWG\API\AbstractClient