infopark_webcrm_sdk 1.1.0 → 2.0.0

data/lib/crm.rb

@@ -87,8 +87,7 @@ module Crm
   #     limit: 20,
   #     offset: 10,
   #     sort_by: 'created_at',
-  #     sort_order: 'desc',
-  #     include_deleted: true
+  #     sort_order: 'desc'
   #   )
   #   # => Crm::Core::ItemEnumerator with max 20 contacts with last name Johnson from Boston.
   # @param filters [Array<Hash{String => String}>]
@@ -111,13 +110,10 @@ module Crm
   #   * +updated_at+
   # @param sort_order [String] One of +asc+ (ascending) or +desc+ (descending).
   #   For +sort_by+ +score+, the only valid sort order is +desc+ (can be omitted).
-  # @param include_deleted [Boolean]
-  #   whether to include deleted items in the results. Server default: +false+.
   # @return [Crm::Core::ItemEnumerator]
   #   An {Crm::Core::ItemEnumerator enumerator} to iterate over the found items.
   # @api public
-  def self.search(filters: nil, query: nil, limit: :none, offset: 0, sort_by: nil,
-      sort_order: nil, include_deleted: nil)
+  def self.search(filters: nil, query: nil, limit: :none, offset: 0, sort_by: nil, sort_order: nil)
     server_limit = 100
     limit = Float::INFINITY if limit.nil? || limit == :none
     offset ||= 0
@@ -134,7 +130,6 @@ module Crm
         'offset' => offset,
         'sort_by' => sort_by,
         'sort_order' => sort_order,
-        'include_deleted' => include_deleted,
       }.reject { |k, v| v.nil? }
       search_results = Core::RestApi.instance.post('search', params)
       ids.concat(search_results['results'].map { |r| r['id'] })

data/lib/crm/core/mixins/merge_and_deletable.rb

@@ -7,11 +7,10 @@ module Crm; module Core; module Mixins
     # whose ID is +merge_into_id+. Afterwards, the current item is deleted.
     # @param merge_into_id [String]
     #   the ID of the account or contact to which the associated items are assigned.
-    # @return [self] the deleted item.
     # @api public
     def merge_and_delete(merge_into_id)
-      load_attributes(
-          RestApi.instance.post("#{path}/merge_and_delete", {"merge_into_id" => merge_into_id}))
+      RestApi.instance.post("#{path}/merge_and_delete", {"merge_into_id" => merge_into_id})
+      nil
     end
   end
 end; end; end

data/lib/crm/core/mixins/modifiable.rb

@@ -2,7 +2,7 @@ require "active_support/concern"
 
 module Crm; module Core; module Mixins
   # +Modifiable+ is a collection of methods that are used to {ClassMethods#create .create},
-  # {#update}, {#delete}, and {#undelete} an Infopark WebCRM item.
+  # {#update} and {#delete} an Infopark WebCRM item.
   # @api public
   module Modifiable
     extend ActiveSupport::Concern
@@ -54,47 +54,14 @@ module Crm; module Core; module Mixins
       load_attributes(RestApi.instance.put(path, attributes, if_match_header))
     end
 
-    # Soft-deletes this item (i.e. marks it as deleted).
+    # Deletes this item.
     #
-    # The deleted item can be {#undelete undeleted}.
-    # @example
-    #   contact.deleted?
-    #   # => false
-    #
-    #   contact.delete
-    #   # => Crm::Contact
-    #
-    #   contact.deleted?
-    #   # => true
-    # @return [self] the deleted item.
     # @raise [Errors::ResourceConflict] if the item has been changed concurrently.
     #   {Core::BasicResource#reload Reload} it, review the changes and retry.
     # @api public
     def delete
-      load_attributes(RestApi.instance.delete(path, nil, if_match_header))
-    end
-
-    # Undeletes this deleted item.
-    # @example
-    #   contact.deleted?
-    #   # => true
-    #
-    #   contact.undelete
-    #   # => Crm::Contact
-    #
-    #   contact.deleted?
-    #   # => false
-    # @return [self] the undeleted item.
-    # @api public
-    def undelete
-      load_attributes(RestApi.instance.put("#{path}/undelete", {}))
-    end
-
-    # Returns +true+ if the item was deleted (i.e. +item.deleted_at+ is not empty).
-    # @return [Boolean]
-    # @api public
-    def deleted?
-      self['deleted_at'].present?
+      RestApi.instance.delete(path, nil, if_match_header)
+      nil
     end
 
     alias_method :destroy, :delete

data/lib/crm/core/mixins/searchable.rb

@@ -19,14 +19,12 @@ module Crm; module Core; module Mixins
 
       # Returns an {Crm::Core::ItemEnumerator enumerator} for iterating over all items
       # of this base type. The items are sorted by +created_at+.
-      # @param include_deleted [Boolean] whether to include deleted items. Default: +false+.
       # @return [ItemEnumerator]
       # @api public
-      def all(include_deleted: false)
+      def all
         search_configurator.
             sort_by('created_at').
             unlimited.
-            include_deleted(include_deleted).
             perform_search
       end
 

data/lib/crm/core/search_configurator.rb

@@ -51,7 +51,6 @@ module Crm; module Core
         offset: @settings[:offset],
         sort_by: @settings[:sort_by],
         sort_order: @settings[:sort_order],
-        include_deleted: @settings[:include_deleted]
       )
     end
 
@@ -165,23 +164,6 @@ module Crm; module Core
       sort_order('desc')
     end
 
-    # Returns a new {SearchConfigurator} constructed by combining this configuration
-    # with the given +include_deleted+ flag.
-    # @param new_include_deleted [Boolean] whether to include deleted items in the results.
-    # @return [SearchConfigurator]
-    # @api public
-    def include_deleted(new_include_deleted = true)
-      SearchConfigurator.new(@settings.merge(include_deleted: new_include_deleted))
-    end
-
-    # Returns a new {SearchConfigurator} constructed by combining this configuration
-    # and excluding deleted items.
-    # @return [SearchConfigurator]
-    # @api public
-    def exclude_deleted
-      include_deleted(false)
-    end
-
     # @!endgroup
 
     # Iterates over the search results.

data/lib/crm/errors.rb

@@ -58,8 +58,7 @@ module Crm
     end
 
     # +ItemStatePreconditionFailed+ is raised if one or more preconditions
-    # for the attempted action were not satisfied. For example, a deleted item cannot be updated.
-    # It must be undeleted first.
+    # for the attempted action were not satisfied.
     # @api public
     class ItemStatePreconditionFailed < ClientError
       # Returns the unmet preconditions.

data/lib/crm/type.rb

@@ -66,11 +66,10 @@ module Crm
     # @!parse extend Core::Mixins::Modifiable::ClassMethods
 
     # Returns all types.
-    # @param include_deleted [Boolean] whether to include deleted types. Default: +false+.
     # @return [Array<Type>]
     # @api public
-    def self.all(include_deleted: false)
-      Core::RestApi.instance.get('types', { include_deleted: include_deleted }).map do |item|
+    def self.all
+      Core::RestApi.instance.get('types').map do |item|
         new(item)
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: infopark_webcrm_sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Infopark AG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-08 00:00:00.000000000 Z
+date: 2018-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -142,9 +142,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.2
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: Infopark WebCRM SDK
 test_files: []
-has_rdoc: