ontraport_api 0.2.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a97839aad56c249eb9661a4ee7f65adc278de476
-  data.tar.gz: 2d4062e746e2874c17707e0e6a43ca81610629bc
+  metadata.gz: 50858291d18ca45568187334332eeb3ebae2f273
+  data.tar.gz: 1fd0b967adbda2e007532c8fbcbafb4da5d2aee5
 SHA512:
-  metadata.gz: 9b5af05ad83b261edf5c501b179c887062910f8735c1eadc4ad67ce61d4959cc605e207f0a558145e49f22ffc385a7e30e41589818cf7e241ef15d53f481621d
-  data.tar.gz: 281a1d41909463b532310537777e39fc1572bbf5660d5931c6e506062b6cd7775d9d5b0eb72f62949604f7eac47577a75939f2231bdadedb5d40d3ba147cd352
+  metadata.gz: 2906f58101d748efcd566ebb6653c08ce99bd4964f3c6a8823305e84d74e34bc1842e82e630b8a6e95002502f350e6f8f8965677e0b2097b31d6ccbbe2d45827
+  data.tar.gz: ac5d3fd413ef37b14720bc0ef651f672ace6323fc8b94b844ede68554cc52d22f2d101602a029b7364e094f8e3ce09b81305ff0ad7ec73d98140723d9be0023b

data/README.md

@@ -41,13 +41,15 @@ client.get_contact(id)                                        # Get a Contact's
 client.new_contact(contact_params)                            # Create new Contact
 client.update_contact(id, contact_params)                     # Update Contact Details
 client.contact_fields(format)                                 # Fetch Contact Meta Fields
-client.add_tags_to_contacts(tag_ids, contacts_criteria)       # Add Tags to Selected Contacts
+client.add_sequences_to_contact(id, sequence_ids)             # Add Sequences (Array / String) to Contact
+client.add_tags_to_contact(id, tag_ids)                       # Add Tags (Array / String) to Contact
+client.add_tags_to_contacts(tag_ids, contacts_criteria)       # Add Tags (Array / String) to Selected Contacts
 client.remove_tags_from_contacts(tag_ids, contacts_criteria)  # Remove Tags from Selected Contacts
 client.get_contacts(search_criteria)                          # Get List of Contacts based on Search Criteria
 client.get_contacts_by_<field_name>(value)                    # Wildcard alias to client.get_contacts("<field_name> = 'value'")
 ```
 
-### Tags (experimental)
+### Tags
 
 ```ruby
 client.get_tags(conditions)                 # Get Tags by condition
@@ -55,19 +57,13 @@ client.new_tag(tag_name)                    # Create new Tag with tag_name
 client.get_tags_by_<field_name>(value)      # Wildcard alias to client.get_tags("<field_name> = 'value'")
 ```
 
-### Sequences (experimental)
+### Sequences
 
 ```ruby
 client.get_sequences(conditions)                # Get all sequences
 client.get_sequences_by_<field_name>(value)     # Wildcard alias to client.get_sequences("<field_name> = 'value'")
 ```
 
-### Contact Sequences (experimental)
-
-```ruby
-client.add_sequence_to_contact(sequence_drip_id, contact_id)    # Add Sequence to Contact
-```
-
 See https://api.ontraport.com/doc/ on details of parameters.
 
 
@@ -126,7 +122,7 @@ Adding Sequence to Contact:
 
 ```ruby
 sequence = client.get_sequences_by_name('Sales Funnel')
-result = client.add_sequence_to_contact(sequence['drip_id'], contact['id'])
+result = client.add_sequences_to_contact(contact['id'], sequence['drip_id'])
 puts 'Success' if result['error'].nil?
 ```
 
@@ -157,6 +153,10 @@ Otherwise, they're missing because I haven't got to them yet. Check the TODO lis
 
 ## Release Notes
 
+#### v0.3.1
+- Deprecated #add_sequence_to_contact in favour of #add_sequences_to_contact since it did not trigger sequence immediately
+- Breaks v0.2.2 implementation
+
 #### v0.2.2
 - Added generic Object query
 

data/lib/ontraport_api/apis/contacts.rb

@@ -6,8 +6,10 @@ module OntraportApi
         'get_contact'                 => [:get,     '/object'],
         'new_contact'                 => [:post,    '/objects'],
         'update_contact'              => [:put,     '/objects'],
+        'add_sequences_to_contact'    => [:put,     '/objects'],
         'get_contacts'                => [:get,     '/objects'],
         'contact_fields'              => [:get,     '/objects/meta'],
+        'add_tags_to_contact'         => [:put,     '/objects/tag'],
         'add_tags_to_contacts'        => [:put,     '/objects/tag'],
         'remove_tags_from_contacts'   => [:delete,  '/objects/tag']
       }
@@ -24,6 +26,15 @@ module OntraportApi
         query_contacts(payload.merge(id: id))
       end
 
+      def add_sequences_to_contact(id, sequence_ids)
+        sequence_ids = sequence_ids.is_a?(Array) ? sequence_ids.join('*/*') : sequence_ids
+        query_contacts({ id: id, updateSequence: "*/*#{sequence_ids}*/*" })
+      end
+
+      def add_tags_to_contact(id, tag_ids)
+        add_tags_to_contacts(tag_ids, "id = #{id}")
+      end
+
       def contact_fields(format = {})
         default_format = { format: 'byId' }
         format = default_format.merge(format)

data/lib/ontraport_api/client.rb

@@ -1,6 +1,5 @@
 require 'httparty'
 require_relative 'apis/contacts'
-require_relative 'apis/contact_sequences'
 require_relative 'apis/forms'
 require_relative 'apis/messages'
 require_relative 'apis/objects'
@@ -16,7 +15,6 @@ module OntraportApi
     base_uri 'https://api.ontraport.com/1'
 
     include APIs::Contacts
-    include APIs::ContactSequences
     include APIs::Products
     include APIs::Forms
     include APIs::Messages

data/lib/ontraport_api/version.rb

@@ -1,3 +1,3 @@
 module OntraportApi
-  VERSION = "0.2.2"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ontraport_api
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.1
 platform: ruby
 authors:
 - Jimmy Ngu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-16 00:00:00.000000000 Z
+date: 2015-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -79,7 +79,6 @@ files:
 - README.md
 - Rakefile
 - lib/ontraport_api.rb
-- lib/ontraport_api/apis/contact_sequences.rb
 - lib/ontraport_api/apis/contacts.rb
 - lib/ontraport_api/apis/forms.rb
 - lib/ontraport_api/apis/messages.rb

data/lib/ontraport_api/apis/contact_sequences.rb

@@ -1,20 +0,0 @@
-module OntraportApi
-  module APIs
-    module ContactSequences
-      CONTACT_SEQUENCES_OBJECT_ID = 8
-      CONTACT_SEQUENCES_API_METHODS_AND_PATHS = {
-        'add_sequence_to_contact' => [:post,     '/objects']
-      }
-
-      def add_sequence_to_contact(sequence_id, contact_id)
-        query_contact_sequences({ drip_id: sequence_id, contact_id: contact_id })
-      end
-
-      def query_contact_sequences(payload)
-        method, path = CONTACT_SEQUENCES_API_METHODS_AND_PATHS[caller[0][/`.*'/][1..-2]]
-        query(method, path, payload.merge({ objectID: CONTACT_SEQUENCES_OBJECT_ID }))
-      end
-
-    end
-  end
-end