Overview
  • Namespace
  • Class

Namespaces

  • APWG
    • API
      • Alerts
      • Groups
      • Index
      • MalIP
      • Phish
      • ReportPhishing

Classes

  • APWG\API\AbstractClient
  • APWG\API\Alerts\AlertsClient
  • APWG\API\Groups\GroupsClient
  • APWG\API\Index\IndexClient
  • APWG\API\MalIP\MalIPClient
  • APWG\API\Phish\PhishClient
  • APWG\API\ReportPhishing\ReportPhishingClient

Interfaces

  • APWG\API\ClientInterface
 1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 
<?php

namespace APWG\API\ReportPhishing;

use APWG\API\AbstractClient;
use Psr\Http\Message\ResponseInterface;


/**
 * Interact with the Report_Phishing API
 *
 * Class ReportPhishingClient
 * @package   APWG\API\ReportPhishing
 * @author Andrew Breksa <andrew@apwg.org>
 * @copyright Copyright (c) 2017 The Anti-Phishing Working Group
 */
class ReportPhishingClient extends AbstractClient {

    /**
     * Searches the report_phishing module
     *
     * @param array $options an associative array of query parameters
     *
     * @return ResponseInterface
     */
    public function search($options = []) {
        return $this->_call('get', 'report_phishing', [
            'query' => $options,
        ]);
    }


    /**
     * Gets a specific email
     *
     * @param int $id the email id
     * @param array $options an associative array of query parameters
     *
     * @return ResponseInterface
     */
    public function get($id, $options = []) {
        return $this->_call('get', 'report_phishing/' . $id, [
            'query' => $options,
        ]);
    }

    /**
     * Return a JSON schema for the report_phishing module's GET:/report_phishing endpoint parameters, useful for validating Alert queries
     *
     * @param int $id the phish id
     * @param array $options an associative array of query parameters
     *
     * @return ResponseInterface
     */
    public function getParamSchema($options = []) {
        return $this->_call('get', 'report_phishing/param_schema', [
            'query' => $options,
        ]);
    }

}
API documentation generated by ApiGen