Merge branch 'master' into master

Author: rbibby

README.md

@@ -1,4 +1,4 @@
-UKFast API PHP client
+UKFast API PHP SDK
 =====================
 [![Build Status](https://travis-ci.org/ukfast/sdk-php.svg?branch=master)](https://travis-ci.org/ukfast/sdk-php)
 [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
@@ -19,6 +19,8 @@ The recommended way to install this package is through [composer](https://getcom
 composer require ukfast/sdk
 ```
 
+Alternativly you can download one of our [tagged releases](https://github.com/ukfast/sdk-php/releases) for manual installation, we dont recommend cloning the master branch for use in production environments as we cannot guarentee its stability.
+
 This package does currently support PHP 5.6+, but we recommend moving to 7.1+ as soon as possible. 
 
 
@@ -43,12 +45,14 @@ foreach ($page->getItems() as $request) {
 }
 ```
 
+We have a [collection of examples](/examples/) of common functionality for each service to help you get started.
+
 
 Contributing
 ------------
 
 We welcome contributions that will benefit other users, 
-please see [CONTRIBUTING](CONTRIBUTING.md) for details on how to get involved.
+please see [CONTRIBUTING](CONTRIBUTING.md) for details on how you can get involved.
 
 
 License

examples/safedns/zoneRecords.php

@@ -13,7 +13,7 @@
 $zoneName = $argv[1];
 $zone = $safedns->zones()->getByName($zoneName);
 
-foreach ($safedns->records()->getAllByZoneName($zone->name) as $record) {
+foreach ($safedns->records()->getByZoneName($zone->name) as $record) {
     echo "# {$record->id} {$record->name} {$record->type} {$record->content} \n";
 }
 

src/Account/Client.php

@@ -31,4 +31,20 @@ public function credits()
     {
         return (new CreditClient($this->httpClient))->auth($this->token);
     }
+
+    /**
+     * @return BaseClient
+     */
+    public function invoices()
+    {
+        return (new InvoiceClient($this->httpClient))->auth($this->token);
+    }
+
+    /**
+     * @return BaseClient
+     */
+    public function invoiceQueries()
+    {
+        return (new InvoiceQueryClient($this->httpClient))->auth($this->token);
+    }
 }

src/Account/Entities/Company.php

@@ -24,6 +24,11 @@ class Company
      */
     public $isDemoAccount;
 
+    /**
+     * @var string
+     */
+    public $name;
+
     /**
      * Company constructor.
      * @param null $item
@@ -39,5 +44,7 @@ public function __construct($item = null)
 
         $this->primaryContactId = $item->primary_contact_id;
         $this->isDemoAccount = $item->is_demo_account;
+
+        $this->name = $item->name;
     }
 }

src/Account/Entities/Invoice.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace UKFast\SDK\Account\Entities;
+
+use DateTime;
+
+class Invoice
+{
+    /**
+     * @var int
+     */
+    public $id;
+
+    /**
+     * @var \Datetime
+     */
+    public $date;
+
+    /**
+     * @var bool
+     */
+    public $paid;
+
+    /**
+     * @var float
+     */
+    public $net;
+
+    /**
+     * @var float
+     */
+    public $vat;
+
+    /**
+     * @var float
+     */
+    public $gross;
+
+    /**
+     * Invoice constructor.
+     *
+     * @param null $item
+     */
+    public function __construct($item = null)
+    {
+        if (empty($item)) {
+            return;
+        }
+
+        $this->id = $item->id;
+        $this->date = DateTime::createFromFormat('Y-m-d', $item->date);
+        $this->paid = $item->paid;
+        $this->net = $item->net;
+        $this->vat = $item->vat;
+        $this->gross = $item->gross;
+    }
+}

src/Account/Entities/InvoiceQuery.php

@@ -0,0 +1,91 @@
+<?php
+
+namespace UKFast\SDK\Account\Entities;
+
+use DateTime;
+
+class InvoiceQuery
+{
+    /**
+     * @var int
+     */
+    public $id;
+
+    /**
+     * @var int
+     */
+    public $contactId;
+
+    /**
+     * @var int
+     */
+    public $amount;
+
+    /**
+     * @var string
+     */
+    public $whatWasExpected;
+
+    /**
+     * @var string
+     */
+    public $whatWasReceived;
+
+    /**
+     * @var string
+     */
+    public $proposedSolution;
+
+    /**
+     * @var array
+     */
+    public $invoiceIds;
+
+    /**
+     * @var string
+     */
+    public $contactMethod;
+
+    /**
+     * @var string
+     */
+    public $resolution;
+
+    /**
+     * @var \DateTime
+     */
+    public $resolutionDate;
+
+    /**
+     * @var string
+     */
+    public $status;
+
+    /**
+     * InvoiceQuery constructor.
+     *
+     * @param null $item
+     */
+    public function __construct($item = null)
+    {
+        if (empty($item)) {
+            return;
+        }
+
+        $resolutionDate = ($item->resolution_date != null)
+            ? DateTime::createFromFormat(DateTime::ISO8601, $item->resolution_date)
+            : null;
+
+        $this->id = $item->id;
+        $this->contactId = $item->contact_id;
+        $this->amount = $item->amount;
+        $this->whatWasExpected = $item->what_was_expected;
+        $this->whatWasReceived = $item->what_was_received;
+        $this->proposedSolution = $item->proposed_solution;
+        $this->invoiceIds = $item->invoice_ids;
+        $this->contactMethod = $item->contact_method;
+        $this->resolution = $item->resolution;
+        $this->resolutionDate = $resolutionDate;
+        $this->status = $item->status;
+    }
+}

src/Account/InvoiceClient.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace UKFast\SDK\Account;
+
+use UKFast\SDK\Account\Entities\Invoice;
+use UKFast\SDK\Client as BaseClient;
+use UKFast\SDK\Page;
+use UKFast\SDK\SelfResponse;
+
+class InvoiceClient extends BaseClient
+{
+    protected $basePath = 'account/';
+    
+    /**
+     * Gets a paginated response of all Invoices
+     *
+     * @param int $page
+     * @param int $perPage
+     * @param array $filters
+     * @return Page
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     */
+    public function getPage($page = 1, $perPage = 15, $filters = [])
+    {
+        $page = $this->paginatedRequest('v1/invoices', $page, $perPage, $filters);
+        $page->serializeWith(function ($item) {
+            return new Invoice($item);
+        });
+
+        return $page;
+    }
+
+    /**
+     * Gets an individual invoice
+     *
+     * @param string $id
+     * @return Invoice
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     */
+    public function getById($id)
+    {
+        $response = $this->request("GET", "v1/invoices/$id");
+        $body = $this->decodeJson($response->getBody()->getContents());
+        return new Invoice($body->data);
+    }
+}

src/Account/InvoiceQueryClient.php

@@ -0,0 +1,91 @@
+<?php
+
+namespace UKFast\SDK\Account;
+
+use UKFast\SDK\Account\Entities\InvoiceQuery;
+use UKFast\SDK\Client as BaseClient;
+use UKFast\SDK\Page;
+use UKFast\SDK\SelfResponse;
+
+class InvoiceQueryClient extends BaseClient
+{
+    protected $basePath = 'account/';
+
+    /**
+     * Gets a paginated response of all invoice queries
+     *
+     * @param int $page
+     * @param int $perPage
+     * @param array $filters
+     * @return Page
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     */
+    public function getPage($page = 1, $perPage = 15, $filters = [])
+    {
+        $page = $this->paginatedRequest('v1/invoice-queries', $page, $perPage, $filters);
+        $page->serializeWith(function ($item) {
+            return new InvoiceQuery($item);
+        });
+
+        return $page;
+    }
+
+    /**
+     * Gets an individual invoice query
+     *
+     * @param string $id
+     * @return InvoiceQuery
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     */
+    public function getById($id)
+    {
+        $response = $this->request("GET", "v1/invoice-queries/$id");
+        $body = $this->decodeJson($response->getBody()->getContents());
+        return new InvoiceQuery($body->data);
+    }
+
+    /**
+     * @param $invoiceQuery
+     * @return SelfResponse
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     */
+    public function create($invoiceQuery)
+    {
+        $response = $this->post("v1/invoice-queries", $this->invoiceQueryToJson($invoiceQuery));
+        $response = $this->decodeJson($response->getBody()->getContents());
+
+        return (new SelfResponse($response))
+            ->setClient($this)
+            ->serializeWith(function ($response) {
+                return $this->serializeInvoiceQuery($response->data);
+            });
+    }
+
+    /**
+     * Converts a response stdClass into an InvoiceQuery object
+     *
+     * @param \stdClass
+     * @return \UKFast\SDK\Account\Entities\InvoiceQuery
+     */
+    protected function serializeInvoiceQuery($item)
+    {
+        $invoiceQuery = new Entities\InvoiceQuery($item);
+
+        return $invoiceQuery;
+    }
+
+    protected function invoiceQueryToJson($invoiceQuery)
+    {
+        $payload = [
+            'contact_id' => $invoiceQuery->contactId,
+            'amount' => $invoiceQuery->amount,
+            'what_was_expected' => $invoiceQuery->whatWasExpected,
+            'what_was_received' => $invoiceQuery->whatWasReceived,
+            'proposed_solution' => $invoiceQuery->proposedSolution,
+            'invoice_ids' => $invoiceQuery->invoiceIds,
+            'contact_method' => $invoiceQuery->contactMethod
+        ];
+
+        return json_encode($payload);
+    }
+}