teamleader 0.2.0 → 0.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTBmOGY3MWIyMWQ0NmU5YzY1MGEwNzY3NDY0ZjkxMjQ3YmZkN2Y5ZQ==
+    NThkMjM5MmRhNzc0MWM4MjBlNjhkOGIyMjY2ZmUyNDY4YWI3NGViMA==
   data.tar.gz: !binary |-
-    YjYyZDQxY2QxOTA3NWEwMzQxMTlkNWMxYTE3OWM4MzA3MzkzOWZhZA==
+    M2UwOWJkNDc1MTMwOGY4ZDFiYWQ2MTFjOTdhNWFjMzg4ZDAxNmVjNQ==
 SHA512:
   metadata.gz: !binary |-
-    ODU3M2Q0YTQ0NGYyYjNiNDViMmJlMDM0NDIyYWUwMWNmOWE3YWI5MWIxM2Fm
-    ZDJiZjIyYjcyMmVkYWUzZmU2NTNhZGQ1OTc3ZDllNTQ1N2ExYmFmMWYwZDMz
-    NDdhZWVmMmRhMDk4NThhN2IwMjhlMTI5NGVhY2Q1MWVkZWFiNjc=
+    ZjhhMzQ2MTU3OGE5NWQxZjMwZTcwNzMzNmQyNTM2NmEwMjAzNjc0YzAzZTZm
+    MDc5ZTI3ZDY5NTUyMjNjZjNhZjc4YTZjYjBkYWQ5NzVlZDM1NjZiZmZmMzA4
+    MzI1MDQ0ZjRkNDAxNWI1ODVlMDJkMTZmZjM3NjNkODUzY2QwNjU=
   data.tar.gz: !binary |-
-    Yjc2N2IyMDEwNDBkYWNmMzI2ZDlmZWY0NGY5OTNiNWZiNzI5NDM4N2FlNWU4
-    MzYzMjg1MTZlZjliOTYxMTA5Y2FkODFkYmI0MGY3M2MxYTc2MzI1MmRjMmYy
-    OGYxZmIwZDk5MzVhNWM4YjZkODFlOWNjODc2NWNiZDY5YmUzMzE=
+    YzMzMmU0YmFmM2VmYTk1NmI0MjE4NmE4MzVhM2VhMWYwMjVjMGI5ZmI3ZDI5
+    YWQyYzM2ZmE4N2UzNDZmNWUyZjQxYTE0NTRkZDNjZGNjNTRlNDlhZDRiMTAx
+    NmNlMDQ5NmJiYzYxZGRjMzA1YzY0MzE5Njg4OWM1MTEzOWY1ZDg=

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.3.0] - 2017-05-12
+### Added
+- Methods for Contacts (add, get, update, delete, link to company, search, get contacts from a company, get relationships between contacts and companies)
+
 ## [0.2.0] - 2017-05-12
 ### Added
 - Method `link_contact_to_company`

data/README.md

@@ -35,26 +35,66 @@ When a method expects a hash as argument, the hash keys have the same name as de
 
 If a required parameter is missing or if the API returns an error, the method will throw an exception.
 
-### Users
+### General
 
 ```ruby
 teamleader.get_users
+teamleader.get_departments
+teamleader.get_tags
 ```
+
+### Contacts
+
+```ruby
+teamleader.add_contact :forename => "John", :surname => "Doe", :email => "john.doe@provider.com"
+teamleader.update_contact({:contact_id => 123, :track_changes => 0, :forename => "Johnny"})
+teamleader.delete_contact({:contact_id => 123})
+teamleader.link_contact_to_company({:contact_id => 123, :company_id => 456, :mode => "link"})
+teamleader.get_contacts({:amount => 100, :pageno => 0, :searchby => "John"}) # pagination starts at 0
+teamleader.get_contact({:contact_id => 123})
+teamleader.get_contacts_by_company({:company_id => 123})
+teamleader.get_contact_company_relations({:amount => 10, :pageno => 0})
+```
+
 ### Companies
 
 ```ruby
 teamleader.add_company({:name => "Hello World"})
-teamleader.get_company(12345)
+teamleader.get_company({:company_id => 12345})
 teamleader.get_companies({:amount => 100, :pageno => 0, :searchby => "hello"}) # pagination starts at 0
 ```
 
 ### Invoices
 
 ```ruby
-teamleader.get_invoice(12345)
+teamleader.add_invoice({
+    :contact_or_company => "company",
+    :contact_or_company_id => 12345,
+    :sys_department_id => 5678,
+    :description_1 => "My awesome item",
+    :price_1 => 50,
+    :amount_1 => 1
+})
+teamleader.update_invoice_payment_status({:invoice_id => 123, :status => "paid"})
+teamleader.get_invoice({:invoice_id => 123})
+teamleader.download_invoice_pdf({:invoice_id => 123})
 teamleader.get_invoices({:date_from => "01/01/2017", :date_to => "01/05/2017"})
 ```
 
+### Products
+
+```ruby
+teamleader.add_product({
+    :name => "My Awesome Product",
+    :price => 49.99
+})
+teamleader.update_product({:product_id => 123, :price => 39.99})
+teamleader.get_product({:product_id => 123})
+teamleader.delete_product({:product_id => 123})
+teamleader.get_products({:amount => 100, :pageno => 0}) # Pagination starts at 0
+```
+
+
 ## License
 The Teamleader GEM is released under the MIT License.
 

data/lib/teamleader/api.rb

@@ -35,6 +35,47 @@ module Teamleader
       request "/addContact.php", params
     end
 
+    def get_contact(params={})
+      raise "contact_id is required" if params[:contact_id].nil?
+      request "/getContact.php", params
+    end
+
+    def update_contact(params={})
+      raise "contact_id is required" if params[:contact_id].nil?
+      raise "track_changes is required" if params[:track_changes].nil?
+      request "/updateContact.php", params
+    end
+
+    def delete_contact(params={})
+      raise "contact_id is required" if params[:contact_id].nil?
+      request "/deleteContact.php", params
+    end
+
+    def link_contact_to_company(params={})
+      raise "contact_id is required" if params[:contact_id].nil?
+      raise "company_id is required" if params[:company_id].nil?
+      raise "mode is required" if params[:mode].nil?
+      raise "mode must be 'link' or 'unlink'" unless ['link', 'unlink'].include?(params[:status])
+      request "/linkContactToCompany.php", params
+    end
+
+    def get_contacts(params={})
+      raise "amount is required" if params[:amount].nil?
+      raise "pageno is required" if params[:pageno].nil?
+      request "/getContacts.php", params
+    end
+
+    def get_contacts_by_company(params={})
+      raise "company_id is required" if params[:company_id].nil?
+      request "/getContactsByCompany.php", params
+    end
+
+    def get_contact_company_relations(params={})
+      raise "amount is required" if params[:amount].nil?
+      raise "pageno is required" if params[:pageno].nil?
+      request "/getContactCompanyRelations.php", params
+    end
+
     # Returns the ID of the company
     def add_company(params={})
       raise "name is required" if params[:name].nil?
@@ -103,11 +144,6 @@ module Teamleader
       request "/getProduct.php", params
     end
 
-    def get_product(params={})
-      raise "product_id is required" if params[:product_id].nil?
-      request "/getProduct.php", params
-    end
-
     def get_products(params={})
       raise "amount is required" if params[:amount].nil?
       raise "pageno is required" if params[:pageno].nil?

data/lib/teamleader/version.rb

@@ -1,3 +1,3 @@
 module Teamleader
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teamleader
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Pierre-Yves Orban