podio 0.8.0 → 1.0.0

data/lib/podio/models/application_email.rb

@@ -1,22 +1,25 @@
+# @see https://developers.podio.com/doc/email
 class Podio::ApplicationEmail < ActivePodio::Base
   include ActivePodio::Updatable
 
   property :attachments, :boolean
-  property :mappings, :hash  
+  property :mappings, :hash
 
   class << self
+    # @see https://developers.podio.com/doc/email/get-app-email-configuration-622338
     def get_app_configuration(app_id)
       member Podio.connection.get { |req|
         req.url("/email/app/#{app_id}", {})
       }.body
     end
 
+    # @see https://developers.podio.com/doc/email/update-app-email-configuration-622851
     def update_app_configuration(app_id, options)
       Podio.connection.put { |req|
         req.url "/email/app/#{app_id}"
         req.body = options
       }.body
     end
-    
+
   end
 end

data/lib/podio/models/application_field.rb

@@ -1,15 +1,18 @@
+# @see https://developers.podio.com/doc/applications
 class Podio::ApplicationField < ActivePodio::Base
   property :field_id, :integer
   property :type, :string
   property :external_id, :string
   property :config, :hash
   property :status, :string
+  property :label, :string
 
   alias_method :id, :field_id
-  delegate_to_hash :config, :label, :description, :delta, :settings, :required?, :visible?
-  delegate_to_hash :settings, :allowed_values, :referenceable_types, :allowed_currencies, :allowed_mimetypes, :valid_types, :options, :multiple
+  delegate_to_hash :config, :description, :delta, :settings, :required?, :visible?
+  delegate_to_hash :settings, :allowed_values, :referenceable_types, :allowed_currencies, :allowed_mimetypes, :options, :multiple
 
   class << self
+    # @see https://developers.podio.com/doc/applications/get-app-field-22353
     def find(app_id, field_id)
       member Podio.connection.get("/app/#{app_id}/field/#{field_id}").body
     end

data/lib/podio/models/batch.rb

@@ -1,3 +1,4 @@
+# @see https://developers.podio.com/doc/batch
 class Podio::Batch < ActivePodio::Base
   property :batch_id, :integer
   property :name, :string
@@ -17,15 +18,22 @@ class Podio::Batch < ActivePodio::Base
   alias_method :id, :batch_id
 
   class << self
+    # @see https://developers.podio.com/doc/batch/get-batch-6144225
     def find(id)
       member Podio.connection.get("/batch/#{id}").body
     end
 
+    # @see https://developers.podio.com/doc/batch/get-batches-6078877
     def find_all(options={})
       list Podio.connection.get { |req|
         req.url("/batch/", options)
       }.body
     end
+
+    # @see https://developers.podio.com/doc/batch/get-running-batches-15856178
+    def find_running(ref_type, ref_id, plugin)
+      list Podio.connection.get("/batch/#{ref_type}/#{ref_id}/#{plugin}/running/").body
+    end
   end
 
 end

data/lib/podio/models/by_line.rb

@@ -8,4 +8,5 @@ class Podio::ByLine < ActivePodio::Base
   property :name, :string
   property :url, :string
   property :avatar, :integer # Sometimes used by older operations
-end
+  property :last_seen_on, :datetime
+end

data/lib/podio/models/calendar_event.rb

@@ -1,45 +1,98 @@
+# @see https://developers.podio.com/doc/calendar
 class Podio::CalendarEvent < ActivePodio::Base
-  property :type, :string
-  property :id, :integer
-  property :group, :string
+  property :uid, :string
+  property :ref_type, :string
+  property :ref_id, :integer
   property :title, :string
   property :description, :string
   property :location, :string
   property :status, :string
   property :start, :datetime, :convert_timezone => false
+  property :start_utc, :datetime, :convert_timezone => false
   property :start_date, :date
   property :start_time, :string
   property :end, :datetime, :convert_timezone => false
+  property :end_utc, :datetime, :convert_timezone => false
   property :end_date, :date
   property :end_time, :string
   property :link, :string
+  property :app, :hash
+  property :source, :string
+  
+  alias_method :id, :uid
 
   class << self
 
+    # @see https://developers.podio.com/doc/calendar/get-global-calendar-22458
     def find_all(options = {})
       list Podio.connection.get { |req|
         req.url('/calendar/', options)
       }.body
     end
 
+    def find_all_for_linked_account(linked_account_id, options = {})
+      list Podio.connection.get { |req|
+        req.url("/calendar/linked_account/#{linked_account_id}/", options)
+      }.body
+    end
+
+    # @see https://developers.podio.com/doc/calendar/get-space-calendar-22459
     def find_all_for_space(space_id, options={})
       list Podio.connection.get { |req|
         req.url("/calendar/space/#{space_id}/", options)
       }.body
     end
 
+    # @see https://developers.podio.com/doc/calendar/get-app-calendar-22460
     def find_all_for_app(app_id, options={})
       list Podio.connection.get { |req|
         req.url("/calendar/app/#{app_id}/", options)
       }.body
     end
 
+    # @see 
+    def move_event(uid, attributes={})
+      response = Podio.connection.post do |req|
+        req.url "/calendar/event/#{uid}/move"
+        req.body = attributes
+      end
+      member response.body
+    end
+
+    # @see 
+    def move_event_external(linked_account_id, uid, attributes={})
+      response = Podio.connection.post do |req|
+        req.url "/calendar/linked_account/#{linked_account_id}/event/#{CGI.escape(uid)}/move"
+        req.body = attributes
+      end
+      member response.body
+    end
+
+    # @see 
+    def update_event_duration(uid, attributes={})
+      response = Podio.connection.put do |req|
+        req.url "/calendar/event/#{uid}/duration"
+        req.body = attributes
+      end
+      member response.body
+    end
+
+    # @see 
+    def update_event_duration_external(linked_account_id, uid, attributes={})
+      response = Podio.connection.put do |req|
+        req.url "/calendar/linked_account/#{linked_account_id}/event/#{CGI.escape(uid)}/duration"
+        req.body = attributes
+      end
+      member response.body
+    end
+
     def get_calendars_for_linked_acc(acc_id, options={})
       list Podio.connection.get { |req|
         req.url("/calendar/export/linked_account/#{acc_id}/available", options)
       }.body
     end
 
+    # @see https://developers.podio.com/doc/calendar/get-calendar-summary-1609256
     def find_summary(options = {})
       response = Podio.connection.get do |req|
         req.url("/calendar/summary", options)
@@ -49,6 +102,7 @@ class Podio::CalendarEvent < ActivePodio::Base
       response
     end
 
+    # @see https://developers.podio.com/doc/calendar/get-calendar-summary-for-space-1609328
     def find_summary_for_space(space_id)
       response = Podio.connection.get("/calendar/space/#{space_id}/summary").body
       response['today']['events'] = list(response['today']['events'])
@@ -63,6 +117,7 @@ class Podio::CalendarEvent < ActivePodio::Base
       response
     end
 
+    # @see https://developers.podio.com/doc/calendar/get-calendar-summary-for-personal-1657903
     def find_personal_summary
       response = Podio.connection.get("/calendar/personal/summary").body
       response['today']['events'] = list(response['today']['events'])
@@ -70,6 +125,7 @@ class Podio::CalendarEvent < ActivePodio::Base
       response
     end
 
+    # @see https://developers.podio.com/doc/calendar/set-reference-export-9183515
     def set_reference_export(linked_account_id, ref_type, ref_id, attributes={})
       response = Podio.connection.put do |req|
         req.url "/calendar/export/linked_account/#{linked_account_id}/#{ref_type}/#{ref_id}"
@@ -78,16 +134,19 @@ class Podio::CalendarEvent < ActivePodio::Base
       response.status
     end
 
+    # @see https://developers.podio.com/doc/calendar/get-exports-by-reference-7554180
     def get_reference_exports(ref_type, ref_id)
       list Podio.connection.get { |req|
         req.url("/calendar/export/#{ref_type}/#{ref_id}/")
       }.body
     end
 
+    # @see https://developers.podio.com/doc/calendar/stop-reference-export-9183590
     def stop_reference_export(linked_account_id, ref_type, ref_id)
       Podio.connection.delete("/calendar/export/linked_account/#{linked_account_id}/#{ref_type}/#{ref_id}").status
     end
 
+    # @see https://developers.podio.com/doc/calendar/get-global-export-9381099
     def set_global_export(linked_account_id, attributes={})
       response = Podio.connection.put do |req|
         req.url "/calendar/export/linked_account/#{linked_account_id}"
@@ -96,6 +155,7 @@ class Podio::CalendarEvent < ActivePodio::Base
       response.status
     end
 
+    # @see https://developers.podio.com/doc/calendar/get-global-exports-7554169
     def get_global_exports()
       list Podio.connection.get { |req|
         req.url("/calendar/export/")

data/lib/podio/models/calendar_mute.rb

@@ -1,3 +1,4 @@
+# @see https://developers.podio.com/doc/calendar
 class Podio::CalendarMute < ActivePodio::Base
   property :id, :integer
   property :type, :string
@@ -8,16 +9,20 @@ class Podio::CalendarMute < ActivePodio::Base
   property :task, :boolean
 
   class << self
+
+    # @see https://developers.podio.com/doc/calendar/get-mutes-in-global-calendar-62730
     def find_all
       list Podio.connection.get('/calendar/mute/').body
     end
 
+    # @see https://developers.podio.com/doc/calendar/mute-objects-from-global-calendar-79418
     def create(scope_type, scope_id, object_type = nil)
       path = "/calendar/mute/#{scope_type}/#{scope_id}/"
       path += "#{object_type}/" unless object_type.nil?
-      Podio.connection.post(path).status 
+      Podio.connection.post(path).status
     end
 
+    # @see https://developers.podio.com/doc/calendar/unmute-objects-from-the-global-calendar-79420
     def delete(scope_type, scope_id, object_type = nil)
       path = "/calendar/mute/#{scope_type}/#{scope_id}/"
       path += "#{object_type}/" unless object_type.nil?

data/lib/podio/models/category.rb

@@ -1,3 +1,4 @@
+# @see https://developers.podio.com/doc/app-store
 class Podio::Category < ActivePodio::Base
   property :category_id, :integer
   property :type, :string

data/lib/podio/models/comment.rb

@@ -1,15 +1,20 @@
+# @see https://developers.podio.com/doc/comments
 class Podio::Comment < ActivePodio::Base
   property :comment_id, :integer
   property :value, :string
   property :rich_value, :string
-  property :external_id, :integer
+  property :external_id, :string
   property :space_id, :integer
   property :created_on, :datetime
+  property :like_count, :integer
+  property :is_liked, :boolean
   property :files, :array # when outputting comments
   property :file_ids, :array # when inputting comments
   property :embed_id, :integer #optional, when inputting comments
   property :embed_file_id, :integer #optional, when inputting comments
 
+  has_one :ref, :class => 'Reference'
+
   has_one :embed, :class => 'Embed'
   has_one :embed_file, :class => 'FileAttachment'
 
@@ -18,23 +23,31 @@ class Podio::Comment < ActivePodio::Base
   has_many :files, :class => 'FileAttachment'
   has_many :questions, :class => 'Question'
 
+  has_many :granted_users, :class => 'Contact' # Only set when creating new comment
+  has_many :invited_users, :class => 'Contact' # Only set when creating new comment
+
   alias_method :id, :comment_id
   attr_accessor :commentable_type, :commentable_id
 
-  def create
-    self.comment_id = Comment.create(commentable_type, commentable_id, attributes)
+  # @see https://developers.podio.com/doc/comments/add-comment-to-object-22340
+  def create(options={})
+    updated_attributes = Comment.create(self.commentable_type, self.commentable_id, self.attributes, options)
+    self.attributes = updated_attributes.symbolize_keys
+    self.initialize_attributes(self.attributes)
   end
-  
+
   class << self
-    def create(commentable_type, commentable_id, attributes)
+    # @see https://developers.podio.com/doc/comments/add-comment-to-object-22340
+    def create(commentable_type, commentable_id, attributes, options={})
       response = Podio.connection.post do |req|
-        req.url "/comment/#{commentable_type}/#{commentable_id}"
+        req.url("/comment/#{commentable_type}/#{commentable_id}", options)
         req.body = attributes
       end
 
-      response.body['comment_id']
+      response.body
     end
 
+    # @see https://developers.podio.com/doc/comments/update-a-comment-22346
     def update(id, attributes)
       response = Podio.connection.put do |req|
         req.url "/comment/#{id}"
@@ -44,14 +57,17 @@ class Podio::Comment < ActivePodio::Base
       response.status
     end
 
+    # @see https://developers.podio.com/doc/comments/delete-a-comment-22347
     def delete(id)
       Podio.connection.delete("/comment/#{id}").status
     end
 
+    # @see https://developers.podio.com/doc/comments/get-a-comment-22345
     def find(id)
       member Podio.connection.get("/comment/#{id}").body
     end
 
+    # @see https://developers.podio.com/doc/comments/get-comments-on-object-22371
     def find_all_for(commentable_type, commentable_id)
       list Podio.connection.get("/comment/#{commentable_type}/#{commentable_id}").body
     end
@@ -60,6 +76,11 @@ class Podio::Comment < ActivePodio::Base
       #Internal
       list Podio.connection.get("/comment/share/").body
     end
-    
+
+    # @see https://developers.podio.com/doc/comments/get-who-liked-a-comment-29007011
+    def liked_by(id)
+      Podio.connection.get("/comment/#{id}/liked_by/").body.map{|values| Podio::Contact.new(values)}
+    end
+
   end
 end

data/lib/podio/models/condition.rb

@@ -0,0 +1,8 @@
+class Podio::Condition < ActivePodio::Base
+  property :condition_id, :integer
+  property :type, :string
+  property :config, :hash
+  property :negate, :boolean
+
+  alias_method :id, :condition_id
+end

data/lib/podio/models/condition_set.rb

@@ -0,0 +1,40 @@
+class Podio::ConditionSet < ActivePodio::Base
+  property :condition_set_id, :integer
+  property :name, :string
+  property :description, :string
+
+  has_many :conditions, :class => 'Condition'
+
+  alias_method :id, :condition_set_id
+
+  class << self
+    def find_all(options={})
+      list Podio.connection.get { |req|
+        req.url("/condition_set/", options)
+      }.body
+    end
+
+    def find(condition_set_id)
+      member Podio.connection.get("/condition_set/#{condition_set_id}").body
+    end
+
+    def create(attributes)
+      member Podio.connection.post { |req|
+        req.url("/condition_set/")
+        req.body = attributes
+      }.body
+    end
+
+    def update(condition_set_id, attributes)
+      member Podio.connection.put { |req|
+        req.url("/condition_set/#{condition_set_id}")
+        req.body = attributes
+      }.body
+    end
+
+    def delete(condition_set_id)
+      Podio.connection.delete("/condition_set/#{condition_set_id}")
+    end
+  end
+
+end

data/lib/podio/models/contact.rb

@@ -1,16 +1,18 @@
+# @see https://developers.podio.com/doc/contacts
 class Podio::Contact < Podio::Profile
   include ActivePodio::Updatable
 
   property :user_id, :integer
   property :organization, :string
-  property :role, :string # Only available when getting contacts for a space
-  property :removable, :boolean # Only available when getting contacts for a space
   property :type, :string # user, space, connection - blank probably means it's a real user / Podio member
   property :space_id, :integer
   property :link, :string
   property :last_seen_on, :datetime
   property :rights, :array
+
+  # Only available for external contacts
   property :external_id, :string
+  property :external_picture, :string
 
   alias_method :id, :user_id
 
@@ -18,4 +20,13 @@ class Podio::Contact < Podio::Profile
     self.class.update_contact(self.profile_id, self.attributes)
   end
 
+  class << self
+    def find_external(linked_acc_id, external_contact_id)
+      member Podio.connection.post { |req|
+        req.url "/contact/linked_account/#{linked_acc_id}"
+        req.body = { :external_contact_id => external_contact_id }
+      }.body
+    end
+  end
+
 end

data/lib/podio/models/contract.rb

@@ -4,14 +4,18 @@ class Podio::Contract < ActivePodio::Base
   property :contract_id, :integer
   property :org_id, :integer
   property :status, :string
+  property :blocked, :boolean
   property :created_on, :datetime
   property :started_on, :datetime
+  property :created_via, :string
   property :ended_on, :datetime
   property :item_prices, :hash
   property :item_limits, :hash
   property :payment_id, :string
   property :payment_status, :string
+  property :payment_provider, :string
   property :accounting_id, :string
+  property :accounting_provider, :string
   property :full, :boolean
   property :premium_emp_network, :boolean
   property :premium_spaces, :array
@@ -24,14 +28,27 @@ class Podio::Contract < ActivePodio::Base
   property :ended_comment, :string
   property :billing_mail, :string
   property :model, :string
+  property :unpaid_due_date, :datetime
+  property :count_employee, :integer
+  property :count_external, :integer
+  property :yearly_rebate_factor, :decimal
+  property :mrr, :decimal
+  property :days_overdue, :integer
+  property :overdue_status, :string
 
   has_one :org, :class => 'Organization'
   has_one :user, :class => 'User'
+  has_one :sold_by, :class => 'User'
   has_one :price, :class => 'ContractPrice'
+  has_one :price_v2, :class => 'ContractPriceV2'
   has_many :premium_spaces, :class => 'Space'
 
   alias_method :id, :contract_id
 
+  def price_v2=(attributes)
+    self[:price_v2] = attributes
+  end
+
   def premium_space_ids=(values)
     self[:premium_space_ids] = (values || []).map(&:to_i)
   end
@@ -46,6 +63,12 @@ class Podio::Contract < ActivePodio::Base
     self["price"] = pricing
   end
 
+  def calculate_price_v2
+    pricing = self.class.calculate_price_v2(self.contract_id, self.attributes.slice(:full, :premium_emp_network, :premium_space_ids))
+    self.clear_price_v2
+    self["price_v2"] = pricing
+  end
+
   def create_payment(query_string)
     self.class.create_payment(self.contract_id, query_string)
   end
@@ -58,7 +81,27 @@ class Podio::Contract < ActivePodio::Base
     self.class.end(self.id, attributes)
   end
 
-  handle_api_errors_for :update, :delete, :create_payment, :end # Call must be made after the methods to handle have been defined
+  def change_to_fixed
+    self.class.change_to_fixed(self.contract_id,
+      :item_limits => {
+        :employee => self.item_limits['employee'],
+        :external => self.item_limits['external']
+      },
+      :invoice_interval => self.invoice_interval
+    )
+  end
+
+  def change_to_variable
+    self.class.change_to_variable(self.contract_id)
+  end
+
+  def block
+    self.class.block(self.contract_id)
+  end
+
+  def unblock
+    self.class.unblock(self.contract_id)
+  end
 
   class << self
     def find(contract_id)
@@ -69,6 +112,10 @@ class Podio::Contract < ActivePodio::Base
       list Podio.connection.get("/contract/").body
     end
 
+    def find_all_my_offers
+      list Podio.connection.get("/contract/offered/").body
+    end
+
     def find_for_org(org_id)
       list Podio.connection.get("/contract/org/#{org_id}/").body
     end
@@ -77,6 +124,10 @@ class Podio::Contract < ActivePodio::Base
       member Podio.connection.get("/contract/org/#{org_id}/user").body
     end
 
+    def find_all_unpaid
+      list Podio.connection.get("/contract/unpaid/").body
+    end
+
     def create(attributes)
       response = Podio.connection.post do |req|
         req.url "/contract/"
@@ -116,7 +167,16 @@ class Podio::Contract < ActivePodio::Base
         req.url "/contract/#{contract_id}/price"
         req.body = attributes
       end
+    
+      response.body
+    end
 
+    def calculate_price_v2(contract_id, attributes)
+      response = Podio.connection.post do |req|
+        req.url "/contract/#{contract_id}/price/v2"
+        req.body = attributes
+      end
+    
       response.body
     end
 
@@ -128,5 +188,29 @@ class Podio::Contract < ActivePodio::Base
 
       response.body
     end
+
+    def change_to_fixed(contract_id, attributes)
+      response = Podio.connection.post do |req|
+        req.url "/contract/#{contract_id}/change_to/fixed"
+        req.body = attributes
+      end
+
+      response.status
+    end
+
+    def change_to_variable(contract_id)
+      response = Podio.connection.post("/contract/#{contract_id}/change_to/variable")
+      response.status
+    end
+
+    def block(contract_id)
+      response = Podio.connection.post("/contract/#{contract_id}/block")
+      response.status
+    end
+
+    def unblock(contract_id)
+      response = Podio.connection.post("/contract/#{contract_id}/unblock")
+      response.status
+    end
   end
 end