moxiworks_platform 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d70046f5068c47a6d9178766c79098202ace1c2
-  data.tar.gz: a1415726e2d739f552748550414726b00e4c4fd3
+  metadata.gz: f278e1a919743a23212ed85372496a5a0dbb1548
+  data.tar.gz: 09a94c3a6f1ff0781cafa1eed0da74b1f46954f0
 SHA512:
-  metadata.gz: fb909fa1c8e6bf010df56b355778ca45075ab1b55efb1593163a0843a154b9798ba45b09b10a2063f5211d4c866466156166eb3acb1792a231ec1909d0c4fca0
-  data.tar.gz: 2c5196daa5c8dee9fec32fd2a271c71d9ed7e9069c13cf2c4a86077d9c4078b5120b64acb8ddad3af63f0ffdca2ee576768c910e1b3f6e298b3d965ac6872c59
+  metadata.gz: 2d8359b4716ff34c27eb807f08eacd2c2b0c0c0224779ce8e23405c6eaa4c99f64710128f74d801e22d52831c67e508f3afa320a9d6cbf12fb5766d354eb791e
+  data.tar.gz: ea3eb6c0705395285192175c48824aa55eb58ee7d70194a7cb160f6429fb360a7584ba504d326aa4c42c45b00f013f84e7bcd71b205cdb7308069383172c1cd4

data/lib/moxiworks_platform.rb

@@ -9,6 +9,7 @@ require 'moxiworks_platform/event'
 require 'moxiworks_platform/group'
 require 'moxiworks_platform/action_log'
 require 'moxiworks_platform/task'
+require 'moxiworks_platform/email_campaign'
 
 
 

data/lib/moxiworks_platform/email_campaign.rb

@@ -0,0 +1,109 @@
+module  MoxiworksPlatform
+  class EmailCampaign < MoxiworksPlatform::Resource
+    # @!attribute moxi_works_agent_id
+    #   moxi_works_agent_id is the Moxi Works Platform ID of the agent which an ActionLog entry is
+    #   or is to be associated with.
+    #
+    #   this must be set for any Moxi Works Platform transaction
+    #
+    #   @return [String] the Moxi Works Platform ID of the agent
+    attr_accessor :moxi_works_agent_id
+
+    # @!attribute partner_contact_id
+    #   *your system's* unique ID for the Contact
+    #
+    #   this must be set for any Moxi Works Platform transaction
+    #
+    #   @return [String] your system's unique ID for the contact
+    attr_accessor :partner_contact_id
+
+    # @!attribute subscription_type
+    #   the type of this EmailCampaign
+    #
+    #   @return [String]
+    attr_accessor :subscription_type
+
+    # @!attribute email_address
+    #   the email address that is configured for this email campaign
+    #
+    #   @return [String]
+    attr_accessor :email_address
+
+    # @!attribute subscribed_at
+    #   the Unix timestamp representing the date/time this campaign was created
+    #
+    #   @return [Integer]
+    attr_writer :subscribed_at
+
+    # @!attribute area
+    #   the area used for this EmailCampaign
+    #
+    #   This will likely be simply a zip code, but allow for arbitrary human readable
+    #     strings referencing geographical locations.
+    #
+    #   @return [String]
+    attr_accessor :area
+
+    # @!attribute last_sent
+    #   the Unix timestamp representing the date/time that the last email of this campaign was sent.
+    #
+    #   if no email has been sent for this campaign, the value will be 0
+    #
+    #   @return [Integer]
+    attr_writer :last_sent
+
+    # @!attribute next_scheduled
+    #   the Unix timestamp representing the date/time the next email of this campaign will be sent.
+    #
+    #   if no email is scheduled to be sent for this campaign, the value will be 0
+    #
+    #   @return [Integer]
+    attr_writer :next_scheduled
+
+    # Search an Agent's Email Campaigns in Moxi Works Platform
+    # @param [Hash] opts named parameter Hash
+    # @option opts [String]  :moxi_works_agent_id *REQUIRED* The Moxi Works Agent ID for the agent to which this contact is associated
+    # @option opts [String]  :partner_contact_id *REQUIRED* Your system's unique ID for this contact.
+    #
+    # @return [Array] containing MoxiworkPlatform::EmailCampaign objects
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
+    # @example
+    #     results = MoxiworksPlatform::EmailCampaign.search(
+    #     moxi_works_agent_id: '123abc',
+    #     partner_contact_id: 'mySystemsContactID'
+    #       )
+    #
+    def self.search(opts={})
+      url ||= "#{MoxiworksPlatform::Config.url}/api/email_campaigns"
+      required_opts = [:moxi_works_agent_id, :partner_contact_id]
+      required_opts.each do |opt|
+        raise ::MoxiworksPlatform::Exception::ArgumentError, "#{opt} required" if
+            opts[opt].nil? or opts[opt].to_s.empty?
+      end
+      results = []
+      RestClient::Request.execute(method: :get,
+                                  url: url,
+                                  payload: opts, headers: self.headers) do |response|
+        puts response if MoxiworksPlatform::Config.debug
+        self.check_for_error_in_response(response)
+        json = JSON.parse(response)
+        json.each do |r|
+          results << MoxiworksPlatform::EmailCampaign.new(r) unless r.nil? or r.empty?
+        end
+      end
+      results
+    end
+
+    private
+
+     def int_attrs
+       [:subscribed_at, :next_scheduled, :last_sent]
+     end
+
+
+  end
+
+end

data/lib/moxiworks_platform/task.rb

@@ -86,12 +86,12 @@ module  MoxiworksPlatform
     # @option opts [String]  :moxi_works_agent_id *REQUIRED* The Moxi Works Agent ID for the agent to which this task is to be associated
     # @option opts [String]  :partner_task_id *REQUIRED* Your system's unique ID for this task.
     # @option opts [String]  :partner_contact_id *REQUIRED* Your system's unique ID for the Contact for whom this Task is to be associated.
+    # @option opts [Integer] :due_at *REQUIRED* Unix timestamp representing the due date
     #
     #     optional Task parameters
     #
     # @option opts [String] :name short description of the task
     # @option opts [String] :description longer description of the task
-    # @option opts [Integer] :due_at Unix timestamp representing the due date
     # @option opts [Integer] :duration Length of time in minutes that the task should take
     #
     # @return [MoxiworksPlatform::Task]
@@ -199,13 +199,13 @@ module  MoxiworksPlatform
     # @option opts [String]  :moxi_works_agent_id *REQUIRED* The Moxi Works Agent ID for the agent to which this task is to be associated
     # @option opts [String]  :partner_task_id *REQUIRED* Your system's unique ID for this task.
     # @option opts [String]  :partner_contact_id *REQUIRED* Your system's unique ID for the Contact for whom this Task is to be associated.
+    # @option opts [Integer] :due_at Unix timestamp representing the due date
+    # @option opts [Integer] :duration Length of time in minutes that the task should take
     #
     #     optional Task parameters
     #
     # @option opts [String] :name short description of the task
     # @option opts [String] :description longer description of the task
-    # @option opts [Integer] :due_at Unix timestamp representing the due date
-    # @option opts [Integer] :duration Length of time in minutes that the task should take
     # @option opts [Integer] :completed_at Unix timestamp representing the date the task was completed
     # @option opts [String] :status enumerated string representing task status
     #

data/lib/moxiworks_platform/version.rb

@@ -1,3 +1,3 @@
 module MoxiworksPlatform
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moxiworks_platform
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Tres Wong-Godfrey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-13 00:00:00.000000000 Z
+date: 2016-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,6 +88,7 @@ files:
 - lib/moxiworks_platform/config.rb
 - lib/moxiworks_platform/contact.rb
 - lib/moxiworks_platform/credentials.rb
+- lib/moxiworks_platform/email_campaign.rb
 - lib/moxiworks_platform/event.rb
 - lib/moxiworks_platform/exception.rb
 - lib/moxiworks_platform/group.rb