infopark_webcrm_sdk 1.1.0 → 2.3.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/log_subscriber.rb

@@ -10,7 +10,7 @@ module Crm; module Core
       info { "#{event.payload[:method].to_s.upcase} #{event.payload[:resource_path]}" }
       request_payload = event.payload[:request_payload]
       if request_payload.present?
-        debug { "  request body: #{parameter_filter.filter(request_payload)}" }
+        debug { "  request body: #{parameter_filter.filter({data: request_payload})[:data]}" }
       end
     end
 
@@ -21,7 +21,7 @@ module Crm; module Core
       }
       debug {
         response_payload = MultiJson.load(r.body)
-        "  response body: #{parameter_filter.filter(response_payload)}"
+        "  response body: #{parameter_filter.filter({data: response_payload})[:data]}"
       }
     end
 

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/mailing.rb

@@ -19,6 +19,16 @@ module Crm
     # @!parse extend Core::Mixins::Modifiable::ClassMethods
     # @!parse extend Core::Mixins::Searchable::ClassMethods
 
+    # Clones a mailing.
+    # @example
+    #   mailing.clone
+    #   # => Crm::Mailing
+    # @return [BasicResource] the cloned mailing.
+    # @api public
+    def clone
+      self.class.new(Core::RestApi.instance.post("#{path}/clone", {}))
+    end
+
     # Renders a preview of the email for the given contact.
     # @example
     #   mailing.html_body

data/lib/crm/mailing_delivery.rb

@@ -0,0 +1,95 @@
+module Crm
+  # MailingDelivery represents a mailing delivery.
+  # @api public
+  class MailingDelivery
+    include Core::Mixins::Inspectable
+    include Core::Mixins::AttributeProvider
+
+    inspectable :mailing_id, :id
+
+    def self.all(mailing_id, since: nil)
+      path = ['mailings', mailing_id, 'mailing_deliveries'].compact.join('/')
+      params = {}
+      case since
+      when Time
+        params[:since] = since.utc.xmlschema
+      when String
+        params[:since] = since
+      when nil
+        # ignore
+      else
+        raise "unknown class of since param: #{since.class}"
+      end
+      Core::RestApi.instance.get(path, params).map {|attrs| new({'mailing_id' => mailing_id}.merge(attrs))}
+    end
+
+    # Creates or updates a mailing delivery.
+    # @example
+    #   Crm::MailingDelivery.create(mailing.id, "abc@example.com", {
+    #     custom_data: {
+    #       salutation: 'Hello You',
+    #     },
+    #   })
+    # @param mailing_id [String] the mailing ID
+    # @param id [String] the email address
+    # @param attributes [Hash{String, Symbol => String}] the new attributes.
+    # @return [self] the created or updated mailing delivery.
+    # @api public
+    def self.create(mailing_id, id, attributes = {})
+      new({'mailing_id' => mailing_id, 'id' => id}).update(attributes)
+    end
+
+    # Returns the requested mailing delivery.
+    # @example
+    #   d = Crm::MailingDelivery.find(mailing.id, "abc@example.com")
+    #   # => #<Crm::MailingDelivery mailing_id="94933088cec0014575ff920ee9830cfb", id="abc@example.com">
+    # @param mailing_id [String] the mailing ID
+    # @param id [String] the email address
+    # @return [MailingDelivery]
+    # @api public
+    def self.find(mailing_id, id)
+      raise Crm::Errors::ResourceNotFound.new("Items could not be found.", [mailing_id]) if mailing_id.blank?
+      raise Crm::Errors::ResourceNotFound.new("Items could not be found.", [id]) if id.blank?
+
+      new({'mailing_id' => mailing_id, 'id' => id}).reload
+    end
+
+    # Deletes the mailing delivery.
+    #
+    # @raise [Errors::ResourceConflict] if the item has been changed concurrently.
+    #   {Core::BasicResource#reload Reload} it, review the changes and retry.
+    # @api public
+    def delete
+      Core::RestApi.instance.delete(path, nil, if_match_header)
+      nil
+    end
+
+    # Updates the attributes of this mailing delivery.
+    # @example
+    #   mailing_delivery.update({
+    #     custom_data: {
+    #       salutation: 'Hello You',
+    #     },
+    #   })
+    # @param attributes [Hash{String, Symbol => String}] the new attributes.
+    # @return [self] the updated mailing delivery.
+    # @api public
+    def update(attributes = {})
+      load_attributes(Core::RestApi.instance.put(path, attributes, if_match_header))
+    end
+
+    def reload
+      load_attributes(Core::RestApi.instance.get(path))
+    end
+
+    private
+
+    def path
+      ['mailings', mailing_id, 'mailing_deliveries', id].compact.join('/')
+    end
+
+    def if_match_header
+      {'If-Match' => self['version']}
+    end
+  end
+end

data/lib/crm/mailing_recipient.rb

@@ -0,0 +1,63 @@
+module Crm
+  # MailingRecipient represents a mailing recipient email address.
+  # @api public
+  class MailingRecipient < Core::BasicResource
+    include Core::Mixins::Inspectable
+    inspectable :id, :active, :consent, :topic_names
+
+    # Returns the requested mailing recipient.
+    # @example
+    #   r = Crm::MailingRecipient.find("abc@example.com")
+    #   r.active
+    #   # => true
+    #   r.consent
+    #   # => "unknown"
+    #   r.consent_given_at
+    #   # => nil
+    #   r.consent_revoked_at
+    #   # => nil
+    #   r.complained_at
+    #   # => nil
+    #   r.permanent_bounced_at
+    #   # => nil
+    #   r.topic_names
+    #   # => ["foo"]
+    #   r.topic_names_unsubscribed
+    #   # => ["bar", "baz"]
+    #   r.consent_logs
+    #   # => [
+    #     {
+    #       "at"=>"2018-06-20T13:13:32Z",
+    #       "description"=>"edited by API2 user root: this is the reason",
+    #       "changes"=>{"active"=>["false", "true"]
+    #     }
+    #   ]
+    # @param email [String] the email address
+    # @return [MailingRecipient]
+    # @api public
+    def self.find(email)
+      if email.blank?
+        raise Crm::Errors::ResourceNotFound.new("Items could not be found.", [email])
+      end
+      new({'id' => email}).reload
+    end
+
+    # Updates the attributes of this mailing recipient.
+    # @example
+    #   mailing_recipient.update({
+    #     consent: "given",
+    #     topic_names: ["foo", "bar"],
+    #     edit_reason: "user registered on www.example.com and confirmed the double opt-in email link",
+    #   })
+    #   mailing_recipient.update({
+    #     consent: "revoked",
+    #     edit_reason: "user unsubscribed using our newsletter form on www.example.com",
+    #   })
+    # @param attributes [Hash{String, Symbol => String}] the new attributes.
+    # @return [self] the updated mailing recipient.
+    # @api public
+    def update(attributes = {})
+      load_attributes(Core::RestApi.instance.put(path, attributes, if_match_header))
+    end
+  end
+end

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.3.0
 platform: ruby
 authors:
 - Infopark AG
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-09-08 00:00:00.000000000 Z
+date: 2020-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -119,6 +119,8 @@ files:
 - lib/crm/event.rb
 - lib/crm/event_contact.rb
 - lib/crm/mailing.rb
+- lib/crm/mailing_delivery.rb
+- lib/crm/mailing_recipient.rb
 - lib/crm/template_set.rb
 - lib/crm/type.rb
 - lib/infopark_webcrm_sdk.rb
@@ -126,7 +128,7 @@ homepage: https://github.com/infopark/webcrm_sdk
 licenses:
 - LGPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -141,10 +143,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Infopark WebCRM SDK
 test_files: []
-has_rdoc: