moxiworks_platform 0.10.4 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3fe438b73c550ab34b50f562a7bae4c7d0e2091
-  data.tar.gz: b21715a1053bcf39630c9043a39cb968e5d68fde
+  metadata.gz: 7431c848e4b2dd54bc300f9cb1c97347d1a43b5f
+  data.tar.gz: 49b6e68c84afd0d7ed8fb6b2bce9b08ea62db8d3
 SHA512:
-  metadata.gz: 398d1f63a98060ab5d5cd0e7bce1f958c8b65158aa2345d96f3cb9c0b317dc0aab6eed29f509fc14d6e7a420128f0ef292529baf1e9eb161d6eaa75632e189f4
-  data.tar.gz: f11f7d012d05c731ab8f3a9614e0800b2d69fcd2569358ead129096a1b157372e263a378e6bb12f556162ff74eac273f83fdacadc95551cd7a92999d45831ecc
+  metadata.gz: 7344c9f350a6822776fbc9fe0a1202876e2a85e5b4af416ec2f7863e6a31ba816c1765538e6a6f0027a0a506e470c56a5c60f66c99f43951a87293a1f5974594
+  data.tar.gz: 19bccbec76e8ff2bbeac644fd3d33ede25a48463b257b08a2d8916021a4e010a2066b885903b35597239558b997f54e6fd06d343efb15b9de24e36c701483b21

data/lib/moxiworks_platform.rb

@@ -16,6 +16,7 @@ require 'moxiworks_platform/listing'
 require 'moxiworks_platform/office'
 require 'moxiworks_platform/buyer_transaction'
 require 'moxiworks_platform/seller_transaction'
+require 'moxiworks_platform/brand'
 
 
 module MoxiworksPlatform

data/lib/moxiworks_platform/agent.rb

@@ -16,6 +16,21 @@ module MoxiworksPlatform
     # @return [String] the UUID of the office which the Agent is associated
     attr_accessor :moxi_works_office_id
 
+     # @!attribute string the id of the agent used by the company of the agent
+    #
+    # @return [String] the UUID of the office which the Agent is associated
+    attr_accessor :client_agent_id
+
+     # @!attribute string the id office used by the company of the agent
+    #
+    # @return [String] the internal of the office which the Agent is associated used by the company
+    attr_accessor :client_office_id
+
+     # @!attribute string the id of the company used by the company of the agent
+    #
+    # @return [String] the UUID of the office which the Agent is associated
+    attr_accessor :client_company_id
+
     # @!attribute address_street
     #
     # @return [String] the agent's address, street and number

data/lib/moxiworks_platform/brand.rb

@@ -0,0 +1,135 @@
+module MoxiworksPlatform
+  # = Moxi Works Platform Brand
+  class Brand < MoxiworksPlatform::Resource
+
+     # @!attribute  URL to logo for the company
+     #
+     # @return [String]
+    attr_accessor :image_logo
+
+     # @!attribute  HTML hexadecimal color code of the presentation accent color for the company
+     #
+     # @return [String]
+    attr_accessor :cma_authoring_color
+
+     # @!attribute  HTML hexadecimal color code of the background color for the company
+     #
+     # @return [String]
+    attr_accessor :background_color
+
+     # @!attribute  HTML hexadecimal color code of the background font color for the company
+     #
+     # @return [String]
+    attr_accessor :background_font_color_primary
+
+     # @!attribute  HTML hexadecimal color code of the background color for buttons displayed
+     #
+     # @return [String]
+    attr_accessor :button_background_color
+
+     # @!attribute  HTML hexadecimal color code of the font color for buttons displayed
+     #
+     # @return [String]
+    attr_accessor :button_font_color
+
+     # @!attribute  copyright declaration for the company. This could include embedded HTML and so should be rendered as if it did.
+     #
+     # @return [String]
+    attr_accessor :copyright
+
+     # @!attribute  HTML the display name for the company as to be presented to end users
+     #
+     # @return [String]
+    attr_accessor :display_name
+
+     # @!attribute  HTML hexadecimal color code of the background color of email elements for the company
+     #
+     # @return [String]
+    attr_accessor :email_element_background_color
+
+     # @!attribute  URL to a logo suitable for placement on a white background (i.e. printing)
+     #
+     # @return [String]
+    attr_accessor :image_cma_pdf_logo_header
+
+     # @!attribute  URL to a logo suitable for placement over the company's email element background color
+     #
+     # @return [String]
+    attr_accessor :image_email_logo_alt
+
+     # @!attribute  URL to a favicon image
+     #
+     # @return [String]
+    attr_accessor :image_favicon
+
+     # @!attribute  URL to a logo suitable for placement over $pres_block_background_color
+     #
+     # @return [String]
+    attr_accessor :image_pres_cover_logo
+
+     # @!attribute  HTML hexadecimal color code of the background color for the company used in block elements of the company's presentations
+     #
+     # @return [String]
+    attr_accessor :pres_block_background_color
+
+     # @!attribute  HTML hexadecimal color code of a text color suitable for placement over $pres_block_background_color
+     #
+     # @return [String]
+    attr_accessor :pres_block_text_color
+
+     # Find an Brand on the  Moxi Works Platform
+     # @param [Hash] opts named parameter Hash
+     # @option opts [String]  :moxi_works_company_id *REQUIRED* The Moxi Works Brand ID for the brand
+     #
+     # @return [MoxiworksPlatform::Brand]
+     #
+     # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+     #     named parameters aren't included
+     #
+     def self.find(opts={})
+       required_opts = [:moxi_works_company_id]
+       raise ::MoxiworksPlatform::Exception::ArgumentError,
+             'arguments must be passed as named parameters' unless opts.is_a? Hash
+       required_opts.each do |opt|
+         raise ::MoxiworksPlatform::Exception::ArgumentError, "#{opt} required" if
+             opts[opt].nil? or opts[opt].to_s.empty?
+       end
+       url = "#{MoxiworksPlatform::Config.url}/api/brands/#{opts[:moxi_works_company_id]}"
+       self.send_request(:get, opts, url)
+     end
+
+
+     # Search For Brands in Moxi Works Platform
+     # @param [Hash] opts named parameter Hash
+     # @option opts [String]  :moxi_works_company_id The Moxi Works Company ID For the search (use Company.search to determine available moxi_works_company_id)
+     # @option opts [String]  :moxi_works_agent_id  The Moxi Works Agent ID For the search (use Agent.search to determine available moxi_works_agent_id)
+     #
+     #
+     #     optional Search parameters
+     #
+     # @option opts [Integer] :page_number the page of results to return
+     #
+     # @return [MoxiworksPlatform::Brand]
+     #
+     # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+     #     named parameters aren't included
+     #
+     # @example
+     #     results = MoxiworksPlatform::Brand.search(
+     #     moxi_works_company_id: 'the_company',
+     #     )
+     #
+     def self.search(opts={})
+       self.send_request(:get, opts)
+     end
+
+
+    def self.send_request(method, opts={}, url=nil)
+      url ||= "#{MoxiworksPlatform::Config.url}/api/brands"
+      super(method, opts, url)
+    end
+    
+
+  end
+end
+

data/lib/moxiworks_platform/contact.rb

@@ -116,6 +116,41 @@ module MoxiworksPlatform
     #   @return [String] -- Default ''
     attr_accessor :occupation
 
+    # @!attribute is_new_contact
+    #   Whether the contact was recently added to the Agent's database.
+    #
+    #   @return [Boolean]
+    attr_accessor :is_new_contact
+
+    # @!attribute birthday
+    #   Birthday of the contact represented as a Unix Timestamp.
+    #
+    #   @return [Integer]
+    attr_accessor :birthday
+
+    # @!attribute anniversary
+    #   Anniversary of the contact represented as a Unix Timestamp.
+    #
+    #   @return [Integer]
+    attr_accessor :anniversary
+
+    # @!attribute home_purchase_anniversary
+    #   Anniversary of the contact's home purchase represented as a Unix Timestamp.
+    #
+    #   @return [Integer]
+    attr_accessor :home_purchase_anniversary
+
+    # @!attribute social_media_profiles
+    #   URLs to any social media profiles that the agent has defined.
+    #
+    # The structure of each social media profile entry will be a Hash with the following
+    #  format
+    #
+    #  { 'key': 'KEY_VAL_AS_STRING', 'url': 'URL_OF_SOCIAL_MEDIA_PROFILE' }
+    #
+    #   @return [Array]
+    attr_accessor :social_media_profiles
+
     # @!attribute partner_agent_id
     #   your system's unique identifier for the agent that this contact will be associated with
     #
@@ -478,6 +513,7 @@ module MoxiworksPlatform
     # @option opts [String] :contact_name  full name of the contact
     # @option opts [String] :email_address full email address of the contact
     # @option opts [String] :phone_number  full phone number of the contact
+    # @option opts [Integer] :updated_since return all Contacts updated after this Unix timestamp
     #
     # @return [Array] containing MoxiworkPlatform::Contact objects
     #

data/lib/moxiworks_platform/version.rb

@@ -1,3 +1,3 @@
 module MoxiworksPlatform
-  VERSION = '0.10.4'
+  VERSION = '0.11.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moxiworks_platform
 version: !ruby/object:Gem::Version
-  version: 0.10.4
+  version: 0.11.0
 platform: ruby
 authors:
 - Tres Wong-Godfrey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-25 00:00:00.000000000 Z
+date: 2017-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,6 +85,7 @@ files:
 - lib/moxiworks_platform.rb
 - lib/moxiworks_platform/action_log.rb
 - lib/moxiworks_platform/agent.rb
+- lib/moxiworks_platform/brand.rb
 - lib/moxiworks_platform/buyer_transaction.rb
 - lib/moxiworks_platform/company.rb
 - lib/moxiworks_platform/config.rb