Merge pull request #4 from easybill/rest-master

Rest master

Author: PATROMO

README.md

@@ -3,6 +3,8 @@ easybill PHP SDK
 
 [![Latest Stable Version](https://poser.pugx.org/easybill/php-sdk/v/stable.png)](https://packagist.org/packages/easybill/php-sdk) [![Total Downloads](https://poser.pugx.org/easybill/php-sdk/downloads.png)](https://packagist.org/packages/easybill/php-sdk) [![Latest Unstable Version](https://poser.pugx.org/easybill/php-sdk/v/unstable.png)](https://packagist.org/packages/easybill/php-sdk) [![License](https://poser.pugx.org/easybill/php-sdk/license.png)](https://packagist.org/packages/easybill/php-sdk)
 
+Switch SDK to [REST API](https://www.easybill.de/api/) **under development!** 
+
 ## Installation
 The recommended way of installing this library is using [Composer](http://getcomposer.org/). 
 
@@ -12,110 +14,31 @@ Add this repository to your composer information using the following command
 composer require easybill/php-sdk
 ```
 
-## Structure/ Functions
+## Usage
 
-```
-// Customer
-Client::searchCustomers($term): Customers
-Client::findCustomer($customerID): Customer|null
-Client::findCustomerByCustomerNumber($customerNumber): Customer|null
-Client::createCustomer(Customer $customer): Customer
-Client::updateCustomer(Customer $customer): Customer
-Client::deleteCustomer($customerID): void
-
-// Customer contact
-Client::findCustomerContacts(): CustomerContacts
-Client::findCustomerContactsByCustomer($customerID): CustomerContacts
-Client::findCustomerContact($contactID): CustomerContact|null
-Client::createCustomerContact(CustomerContact $contact): CustomerContact
-Client::updateCustomerContact(CustomerContact $contact): CustomerContact
-Client::deleteCustomerContact($contactID): void
-
-// Customer group
-Client::findCustomerGroups(): CustomerGroups
-Client::findCustomerGroup($groupID): CustomerGroup|null
-Client::createCustomerGroup(CustomerGroup $group): CustomerGroup
-Client::updateCustomerGroup(CustomerGroup $group): CustomerGroup
-Client::deleteCustomerGroup($groupID): void
-
-// Company position
-Client::searchCompanyPositions($term): CompanyPositions
-Client::findCompanyPosition($positionID): CompanyPosition|null
-Client::createCompanyPosition(CompanyPosition $position): CompanyPosition
-Client::updateCompanyPosition(CompanyPosition $position): CompanyPosition
-Client::deleteCompanyPosition($positionID): void
-
-// Company position group
-Client::findCompanyPositionGroups(): CompanyPositionGroups
-Client::findCompanyPositionGroup($groupID): CompanyPositionGroup
-Client::createCompanyPositionGroup(CompanyPositionGroup $group): CompanyPositionGroup
-Client::updateCompanyPositionGroup(CompanyPositionGroup $group): CompanyPositionGroup
-Client::deleteCompanyPositionGroup($groupID): void
-
-// Document
-Client::findDocument($documentID): Document
-Client::findDocumentsByDocumentNumber($documentNumber): Documents
-Client::findDocuments(DocumentsParams $params): Documents
-Client::createDocument(CreateDocument $document): DocumentCreated
-
-Client::findDocumentPDF($documentID): DocumentFile
-Client::findDocumentPayments($documentID): Payments
-Client::findDocumentSent($documentID): Outbox
-
-Client::createPayment(Payment $payment): boolean
-
-// Reminder
-Client::createReminder(CreateReminder $document): DocumentCreated
-
-// Dunning
-Client::createReminder(CreateReminder $document): DocumentCreated
+```php
+use easybill\SDK\Client;
+use easybill\SDK\Endpoint;
 
-```
+$client = new Client(new Endpoint('... your API key ...'));
+
+$result = $client->request('GET', 'documents');
 
-## Todo
-- toCancelDocument()
-- toCreditDocument()
+print_r($result);
+```
 
-## Todo new SOAP functions
-- upload attachments via soap
-- use attachment by create new document
+## More examples
 
-## Usage
+Check the **examples** folder.
 
-You can look into our [tests](https://github.com/easybill/php-sdk/tree/master/tests/easybill/SDK).
+## Documentation
 
-### Setup
+Please see https://www.easybill.de/api for up-to-date documentation.
 
-```php
-// create a new service client
-$client = new \easybill\SDK\Client('your api secret key');
+## Contributing
 
-// If you want log (psr/log)
-// $client->setLogger(LoggerInterface $logger)
-```
+Please feel free to send bug reports and pull requests.
 
-### Customer usage
+## License
 
-```php
-// create a new customer
-$customer = new \easybill\SDK\Model\Customer();
-$customer->lastName = 'bar';
-$customer = $client->createCustomer($customer); // createCustomer() return a new Customer Object.
-$customer->customerID; // ID from customer. like 333123467
-$customer->customerNumber; // customerNumber from customer. like 1001
-
-// update customer
-$customer->firstName = 'foo';
-try {
-    $customer = $client->updateCustomer($customer);
-} catch(\easybill\SDK\Exception\CustomerNotFoundException $exception) {
-    // customer not found!
-    // if customerID is missing or wrong.
-}
-
-// search customer
-$customers = $client->searchCustomers('bar');
-foreach ($customers as $customer) {
-   $customer->customerID;
-}
-```
+Published as open source under the terms of [MIT License](http://opensource.org/licenses/MIT).

composer.json

@@ -1,11 +1,15 @@
 {
   "name": "easybill/php-sdk",
-  "description": "easybill PHP SDK (SOAP API)",
+  "description": "easybill PHP SDK (API)",
   "keywords": [
-    "PHP", "easybill", "API", "SDK", "SOAP"
+    "PHP",
+    "easybill",
+    "API",
+    "SDK",
+    "REST"
   ],
   "type": "library",
-  "minimum-stability": "dev",
+  "minimum-stability": "stable",
   "license": "MIT",
   "homepage": "https://www.easybill.de",
   "authors": [
@@ -15,17 +19,13 @@
     }
   ],
   "require": {
-    "php": ">=5.3.0",
-    "ext-soap": "*",
-    "doctrine/collections": "~1.2",
-    "psr/log": "~1.0"
-  },
-  "require-dev": {
-    "phpunit/phpunit": "~4.6"
+    "php": ">=5.5",
+    "guzzlehttp/guzzle": "~6.0",
+    "ext-json": "*"
   },
   "autoload": {
     "psr-4": {
-      "easybill\\SDK\\": "easybill/SDK/"
+      "easybill\\SDK\\": "src/"
     }
   }
 }