teamleader 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe8a0c9461b19848e4ac64e19937c65951435ebd
-  data.tar.gz: f469750c1ffb54cfaf5f46eca34ea044e060a0b8
+  metadata.gz: e19b86af8da9c3bb702b39d9d7a237756a633040
+  data.tar.gz: 6922099520faa620154c4c56f490b1ca19d53733
 SHA512:
-  metadata.gz: 17521b7288b35701004fba5da4d20ed068de81088485dde20736308b652ebfbf0f1929daa21a97d55cf718c9c7138030759cec30e8c6684fc0fe4e5763c4ed29
-  data.tar.gz: 0a5bcaca3b174db050711cede6f5c78a7915aa7ab082f3a326842a4c0fc00faee9a48dd028deac7835ef99a4168a622512d7d29114e50b7b15ca2dbe033a0969
+  metadata.gz: 9118e9d7cbf51857b42eb42f523a08c5e2294d67c5dceb9eedadb9e66aa2a284bd89721a95b68df13c9f0496c402dfa7203b435082367b1d15df5e677f06c856
+  data.tar.gz: a89b64ee641eb1133c6886496040e45cd6a4ae83cb6760c8c3a81cf9a1a18a1667b54e4ced25d9e999b5a1116c659d6f72ddaa3e31633dfc976cd34c69da00c3

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.17.0] - 2020-04-09
+- `get_all_subscriptions` method accepts optional parameters (like `selected_customfields` or `searchby`)
+- New methods related to subscriptions: `add_subscription`, `update_subscription`, `delete_subscription`, `get_subscription`, `get_invoices_by_subscription`, `get_related_subscriptions_by_invoice`, `get_subscriptions_by_deal`, `get_subscriptions_by_contact_or_company`
+
 ## [0.16.0] - 2019-05-10
 - New method related to custom fields: `get_custom_fields`, `get_custom_field_info`, `add_custom_field_option`
 

data/README.md

@@ -2,7 +2,9 @@
 
 A ruby wrapper around Teamleader.eu API v1.
 
-**Some endpoints are still missing. Don't hesitate to open an issue or a PR if you need one of them.**
+**Please note that this gem is linked to the [deprecated Teamleader API](https://apidocs.teamleader.be/). Teamleader recommends to use the [new Teamleader API](https://developer.teamleader.eu/).**
+
+Some endpoints are still missing. Don't hesitate to open an issue or a PR if you need one of them.
 
 ## Installation
 
@@ -189,7 +191,7 @@ teamleader.get_call(call_id: '123456')
 ```
 
 ### Subscriptions
-Available methods are: `get_subscriptions`, `get_all_subscriptions`
+Available methods are: `get_subscriptions`, `get_all_subscriptions`, `add_subscription`, `update_subscription`, `delete_subscription`, `get_subscription`, `get_invoices_by_subscription`, `get_related_subscriptions_by_invoice`, `get_subscriptions_by_deal`, `get_subscriptions_by_contact_or_company`
 
 ### Custom Fields
 Available methods are: `get_custom_fields`, `get_custom_field_info`, `add_custom_field_option`

data/lib/teamleader/api.rb

@@ -375,12 +375,6 @@ module Teamleader
       request "/getBusinessTypes.php", params
     end
 
-    def get_subscriptions(params={})
-      raise "amount is required" if params[:amount].nil?
-      raise "pageno is required" if params[:pageno].nil?
-      request "/getSubscriptions.php", params
-    end
-
     private
 
     def request(path, data={})

data/lib/teamleader/api/subscriptions.rb

@@ -0,0 +1,48 @@
+module Teamleader
+  module Subscriptions
+    def add_subscription(params={})
+      required_params(%i[contact_or_company contact_or_company_id sys_department_id date_start repeat_after title], params)
+      request '/addSubscription.php', params
+    end
+
+    def update_subscription(params={})
+      required_params(%i[subscription_id], params)
+      request '/updateSubscription.php', params
+    end
+
+    def delete_subscription(params={})
+      required_params(%i[subscription_id], params)
+      request '/deleteSubscription.php', params
+    end
+
+    def get_subscriptions(params={})
+      required_params(%i[amount pageno], params)
+      request "/getSubscriptions.php", params
+    end
+
+    def get_subscription(params={})
+      required_params(%i[subscription_id], params)
+      request '/getSubscription.php', params
+    end
+
+    def get_invoices_by_subscription(params={})
+      required_params(%i[subscription_id], params)
+      request '/getInvoicesBySubscription.php', params
+    end
+
+    def get_related_subscriptions_by_invoice(params={})
+      required_params(%i[invoice_id], params)
+      request '/getRelatedSubscriptionsByInvoice.php', params
+    end
+
+    def get_subscriptions_by_deal(params={})
+      required_params(%i[deal_id], params)
+      request '/getSubscriptionsByDeal.php', params
+    end
+
+    def get_subscriptions_by_contact_or_company(params={})
+      required_params(%i[contact_or_company contact_or_company_id], params)
+      request '/getSubscriptionsByContactOrCompany.php', params
+    end
+  end
+end

data/lib/teamleader/extended_api.rb

@@ -3,11 +3,11 @@ module Teamleader
   # The Api class is a 1-1 mapping with Teamleader API v1
   # The ExtendedApi adds some utility methods
   class ExtendedApi < Api
-    def get_all_subscriptions
+    def get_all_subscriptions(**args)
       subscriptions = []
       pageno = 0
       loop do
-        results = self.get_subscriptions(pageno: pageno, amount: 100)
+        results = self.get_subscriptions((args || {}).merge({pageno: pageno, amount: 100}))
         subscriptions.concat(results)
         pageno += 1
         break if results.length == 0
@@ -15,4 +15,4 @@ module Teamleader
       subscriptions
     end
   end
-end
+end

data/lib/teamleader/version.rb

@@ -1,3 +1,3 @@
 module Teamleader
-  VERSION = "0.16.0"
+  VERSION = "0.17.0"
 end

data/teamleader.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.8"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency 'rspec', "~> 3.6"
   spec.add_development_dependency "vcr", "~> 3.0"
   spec.add_development_dependency "typhoeus", "~> 1.1"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teamleader
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Pierre-Yves Orban
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-10 00:00:00.000000000 Z
+date: 2020-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +28,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -117,6 +117,7 @@ files:
 - lib/teamleader/api/custom_fields.rb
 - lib/teamleader/api/files.rb
 - lib/teamleader/api/projects.rb
+- lib/teamleader/api/subscriptions.rb
 - lib/teamleader/configuration.rb
 - lib/teamleader/extended_api.rb
 - lib/teamleader/version.rb