vng 3.1.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44bfc4eff4a138fc21a6058eb634d08e8be4bca032b43807c15fea355dfa5fe1
-  data.tar.gz: 414e83652f42d05171fc1413c17d9a817ab02bcd49d340164338e682b886d028
+  metadata.gz: d0040674685e7d8090bd5872e705ce17dd4fae6c16a4390522039719da756c39
+  data.tar.gz: e78eeca80c62145b6e2c9f737b78b1cf971c6597d21fbce910a3981bb89a90c7
 SHA512:
-  metadata.gz: c64946b9ea2609929eb2b89b241dc93fa221df17c081e3548357eb94187d3d58215c59a6522a27d248c53c9009c5df7ec2fe64047b53367748be71988e653d60
-  data.tar.gz: 917f9edb608a9488bd95896fad8e11803494f5598236f8271abc08853159b5a6821c328d99c4db5c9f5fcb138fb4632c99fa5349569e87355edc2a09f013d45f
+  metadata.gz: 1235ebc7d60b12babbfe060ead7aa92905423d87939b48de7996567317ff4c3dbd16b218e803de22522a963fe52e1e22a186f99fe997998001ffb6b8dd778dce
+  data.tar.gz: cf02b625c67a97bb01e670ff08f8026a7395531825db98bd958466d95a8736f23c16aa8cf7cd61122e3326e5d1a647a467484cf7a8925b37a11b8dbc43af45ab

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [3.3.0] - 2025-01-15
+
+- Add SystemObject.find_by(name:)
+
+## [3.2.0] - 2025-01-15
+
+- Add Lead#notes
+
 ## [3.1.0] - 2025-01-11
 
 - Add Client.find(id)

data/lib/vng/lead.rb

@@ -5,16 +5,17 @@ module Vng
   class Lead < Resource
     PATH = '/api/v1/data/Leads/'
 
-    attr_reader :id, :name, :email, :phone
+    attr_reader :id, :name, :email, :phone, :notes
 
-    def initialize(id:, name:, email:, phone:)
+    def initialize(id:, name:, email:, phone:, notes:)
       @id = id
       @name = name
       @email = email
       @phone = phone
+      @notes = notes
     end
 
-    def self.create(name:, email:, phone:)
+    def self.create(name:, email:, phone:, notes: nil, campaign_option_id: nil)
       body = {
         method: '3',
         Fields: [
@@ -25,14 +26,18 @@ module Vng
         ]
       }
 
+      body[:Fields] << { fieldID: 108, fieldValue: notes } if notes
+      body[:Fields] << { fieldID: 795, optionID: campaign_option_id } if campaign_option_id
+
       data = request path: PATH, body: body
 
       id = data['Client']['objectID']
       name = value_for_field data, 127
       email = value_for_field data, 238
       phone = value_for_field data, 1024
+      notes = value_for_field data, 108
 
-      new id: id, name: name, email: email, phone: phone
+      new id: id, name: name, email: email, phone: phone, notes: notes
     end
   end
 end

data/lib/vng/mock_request.rb

@@ -47,6 +47,21 @@ module Vng
           @@logged_out = true
           {}
         end
+      when '/api/v1/system/objects/'
+        if @body[:method] == '1'
+          { "Fields" => [
+            { "fieldID" => 795, "field" => "Marketing Campaign" },
+            { "fieldID" => 830, "field" => "Primary Contact" },
+          ], "Options" => [
+            {"optionID" => 15840, "name" => "Referral", "fieldID" => 795, "objectTypeID" => 28, "isActive" => false},
+            {"optionID" => 15841, "name" => "Website", "fieldID" => 795, "objectTypeID" => 28, "isActive" => true},
+          ] }
+        else
+          { "Objects"=>[
+            { "objectTypeID" => 15, "name" => "User" },
+            { "objectTypeID" => 28, "name" => "Lead" },
+          ] }
+        end
       when '/api/v1/resources/zips/'
         if @body[:method] == '1'
           # TODO: The response already includes the ServiceTypes so there
@@ -118,6 +133,7 @@ module Vng
             { "fieldID"=>126, "fieldValue"=>"Vng Example" },
             { "fieldID"=>238, "fieldValue"=>"vng@example.com" },
             { "fieldID"=>1024, "fieldValue"=>"8648648640" },
+            { "fieldID"=>108, "fieldValue"=>"Lead notes" },
           ] }
         end
       when '/api/v1/data/Contacts/'

data/lib/vng/system_field.rb

@@ -0,0 +1,26 @@
+require 'vng/system_option'
+
+module Vng
+  # Provides methods to interact with Vonigo system fields.
+  class SystemField < Resource
+    PATH = '/api/v1/system/objects/'
+
+    attr_reader :id, :name, :options
+
+    def initialize(id:, name:, options:)
+      @id = id
+      @name = name
+      @options = options
+    end
+
+    def self.for_system_object_id(system_object_id)
+      body = { objectID: system_object_id, method: '1' }
+      data = request path: PATH, body: body
+
+      data['Fields'].lazy.map do |field|
+        options = SystemOption.for_system_field_id field['fieldID'], data['Options']
+        new id: field['fieldID'], name: field['field'], options: options
+      end # TODO: make this thing respond to find_by(name:)
+    end
+  end
+end

data/lib/vng/system_object.rb

@@ -0,0 +1,26 @@
+require 'vng/system_field'
+
+module Vng
+  # Provides methods to interact with Vonigo system objects.
+  class SystemObject < Resource
+    PATH = '/api/v1/system/objects/'
+
+    attr_reader :id, :name, :fields
+
+    def initialize(id:, name:, fields:)
+      @id = id
+      @name = name
+      @fields = fields
+    end
+
+    def self.find_by(name:)
+      data = request path: PATH
+      object = data['Objects'].find{|object| object['name'].eql? name}
+
+      if object
+        fields = SystemField.for_system_object_id object['objectTypeID']
+        new id: object['objectTypeID'], name: name, fields: fields
+      end
+    end
+  end
+end

data/lib/vng/system_option.rb

@@ -0,0 +1,21 @@
+module Vng
+  # Provides methods to interact with Vonigo system fields’ options.
+  class SystemOption
+    attr_reader :id, :name
+
+    def initialize(id:, name:)
+      @id = id
+      @name = name
+    end
+
+    def self.for_system_field_id(system_field_id, options = {})
+      options.lazy.filter_map do |option|
+        next unless option['isActive']
+
+        if option['fieldID'].eql? system_field_id
+          new id: option['optionID'], name: option['name']
+        end
+      end # TODO: make this thing respond to find_by(name:)
+    end
+  end
+end

data/lib/vng/version.rb

@@ -1,3 +1,3 @@
 module Vng
-  VERSION = '3.1.0'
+  VERSION = '3.3.0'
 end

data/lib/vng.rb

@@ -21,6 +21,7 @@ require_relative 'vng/price_item'
 require_relative 'vng/route'
 require_relative 'vng/security_token'
 require_relative 'vng/service_type'
+require_relative 'vng/system_object'
 require_relative 'vng/version'
 require_relative 'vng/work_order'
 require_relative 'vng/zip'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: vng
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.3.0
 platform: ruby
 authors:
 - claudiob
 bindir: exe
 cert_chain: []
-date: 2025-01-11 00:00:00.000000000 Z
+date: 2025-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -89,6 +89,9 @@ files:
 - lib/vng/route.rb
 - lib/vng/security_token.rb
 - lib/vng/service_type.rb
+- lib/vng/system_field.rb
+- lib/vng/system_object.rb
+- lib/vng/system_option.rb
 - lib/vng/version.rb
 - lib/vng/work_order.rb
 - lib/vng/zip.rb