moxiworks_platform 0.11.3 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f30e0f092e72c478b298575a4e59acb1fe6f5cc
-  data.tar.gz: 597bff8b2aecc6b068e7e22e7d00cf62fe343b24
+  metadata.gz: ec4c41788c2815f64aab1734e99120f0df9ed25e
+  data.tar.gz: 57eb6780ceebce6f9b9b79a350906c00cec174bb
 SHA512:
-  metadata.gz: 4d656ba4e354e1f6773a41fc8db9a975dc8ea851e4ca88d2ace6a85e60f73adcd3c34e471be2394cd4553eea352f3c14ad81a9c7bf1ad867fbf9e980a1bc9a61
-  data.tar.gz: 4139bc33e53334f094d95a7d25bf9f19a14e0698ac66c98f2d5ccf2460e332027a628261eff8c83281a983329d74c87cc7e922c6ac7088bb1c977b5efa50e78a
+  metadata.gz: 9ba19076c5f10ba8e819a895d2b0a5b6bc60cd86f369fbe6fb40ec056a0126a9e059c8bf2d6991277f2b589661ed2673413ccbe7b57dea559c4f7f01a1c077d8
+  data.tar.gz: 39828052e7381fe31b5b9037511c681dc592c90eee9af97817f22f6131e18981d4afb277c8f5721643a6117956d3f72f71f155bf22ebdbbabf5c4865a1ee2d5f

data/lib/moxiworks_platform.rb

@@ -17,6 +17,11 @@ require 'moxiworks_platform/office'
 require 'moxiworks_platform/buyer_transaction'
 require 'moxiworks_platform/seller_transaction'
 require 'moxiworks_platform/brand'
+require 'moxiworks_platform/gallery'
+require 'moxiworks_platform/presentation_log'
+require 'moxiworks_platform/sold_listing'
+require 'moxiworks_platform/team'
+
 
 
 module MoxiworksPlatform

data/lib/moxiworks_platform/agent.rb

@@ -158,7 +158,8 @@ module MoxiworksPlatform
 
     # Find an Agent on the  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
+    # @option opts [String]  :moxi_works_agent_id  *REQUIRED* -- either :moxi_works_agent_id or :agent_uuid is required -- The Moxi Works Agent ID for the agent
+    # @option opts [String]  :agent_uuid *REQUIRED* -- either :moxi_works_agent_id or :agent_uuid is required -- The Moxi Works Agent ID for the agent
     #
     # @return [MoxiworksPlatform::Agent]
     #
@@ -166,13 +167,17 @@ module MoxiworksPlatform
     #     named parameters aren't included
     #
     def self.find(opts={})
-      url = "#{MoxiworksPlatform::Config.url}/api/agents/#{opts[:moxi_works_agent_id]}"
+      agent_identifier = opts[:agent_uuid] unless(opts[:agent_uuid].nil? or opts[:agent_uuid].empty?)
+       agent_identifier ||= opts[:moxi_works_agent_id] unless(opts[:moxi_works_agent_id].nil? or opts[:moxi_works_agent_id].empty?)
+      raise ::MoxiworksPlatform::Exception::ArgumentError, "#agent_uuid or moxi_works_agent_id required" if
+          agent_identifier.nil?
+      url = "#{MoxiworksPlatform::Config.url}/api/agents/#{agent_identifier}"
       self.send_request(:get, opts, url)
     end
 
     def self.send_request(method, opts={}, url=nil)
       url ||= "#{MoxiworksPlatform::Config.url}/api/agents"
-      required_opts = [:moxi_works_agent_id]
+      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|

data/lib/moxiworks_platform/gallery.rb

@@ -0,0 +1,107 @@
+module MoxiworksPlatform
+  # = Moxi Works Platform Gallery
+  class Gallery < MoxiworksPlatform::Resource
+
+    # @!attribute list_office_aor
+    #
+    # @return [String] MLS the listing is listed with
+    attr_accessor :list_office_aor
+
+    # @!attribute listing_id
+    #
+    # @return [String] the mls number associated with the listing
+    attr_accessor :listing_id
+
+
+    # @!attribute listing_images
+    #
+    # @return [Array] array of image Hashes in the format
+    #  {
+    #     thumb_url: [String] url to thumbail size image (smallest),
+    #     small_url: [String] url to small size image (small),
+    #     full_url: [String] url to full size image (medium),
+    #     gallery_url: [String] url to gallery size image (large),
+    #     raw_url: [String] url to raw image (largest)
+    #     title: [String] human readable title of image
+    #     is_main_listing_image: [Boolean] whether the image is the main image for the listing
+    #     caption: [String] human readable caption for the image
+    #     description: [String] human readable description of the image
+    #     width: [Integer] width of the raw image
+    #     height: [Integer] height of the raw image
+    #     mime_type: [String] MIME or media type of the image
+    #
+    #  }
+    attr_accessor :gallery_images
+
+
+    # Search For Galleries in Moxi Works Platform
+    # @param [Hash] opts named parameter Hash
+    # @option opts [String]  :moxi_works_company_id *REQUIRED* 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) -- only agent_uuid or moxi_works_agent_id are needed when searching for galleries by agent
+    # @option opts [String]  :agent_uuid  The Agent UUID For the search (use Agent.search to determine available agent_uuid) -- only agent_uuid or moxi_works_agent_id are needed when searching for galleries by agent
+    #
+    #
+    #     optional Search parameters
+    #
+    #
+    # @return [Hash] with the format:
+    #   {
+    #     last_page: [Boolean],
+    #     galleries:  [Array] containing MoxiworkPlatform::Gallery objects
+    #   }
+    #
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
+    # @example
+    #     results = MoxiworksPlatform::Gallery.search(
+    #     moxi_works_company_id: 'the_company',
+    #     moxi_works_agent_id: 'abc123'
+    #     )
+    #
+    #
+    # @block |Array|
+    #    if you pass a block with the logic you want to perform on all galleries,
+    #    you can have all galleries processed in a single call
+    #
+    # @example
+    #     MoxiworksPlatform::Gallery.search(
+    #        moxi_works_company_id: 'the_company',
+    #          moxi_works_agent_id: 'abc123'
+    #         agent_uuid: 'abc123') { |galleries| puts galleries.count }
+    #
+    def self.find(opts={})
+      required_opts = [:moxi_works_company_id]
+      required_opts.each do |opt|
+        raise ::MoxiworksPlatform::Exception::ArgumentError, "#{opt} required" if
+            opts[opt].nil? or opts[opt].to_s.empty?
+      end
+      agent_identifier = opts[:agent_uuid] unless(opts[:agent_uuid].nil? or opts[:agent_uuid].empty?)
+      agent_identifier ||= opts[:moxi_works_agent_id] unless(opts[:moxi_works_agent_id].nil? or opts[:moxi_works_agent_id].empty?)
+      raise ::MoxiworksPlatform::Exception::ArgumentError, "#agent_uuid or moxi_works_agent_id required" if
+          agent_identifier.nil?
+
+      url = "#{MoxiworksPlatform::Config.url}/api/galleries/#{agent_identifier}"
+
+      results = []
+      json = {'galleries': []}
+      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 = self.underscore_attribute_names json
+        json['galleries'].each do |r|
+          results << MoxiworksPlatform::Gallery.new(r) unless r.nil? or r.empty?
+        end
+        json['galleries'] = results
+      end
+      if block_given?
+        yield(json['galleries'])
+      end
+      json
+    end
+  end
+end

data/lib/moxiworks_platform/presentation_log.rb

@@ -0,0 +1,158 @@
+module MoxiworksPlatform
+  # = Moxi Works Platform PresentationLog
+  class PresentationLog < MoxiworksPlatform::Resource
+
+    # @!attribute  agent_uuid
+    #
+    # @return [string] This is the Moxi Works Platform ID of the presentation_log which an ActionLog entry is associated with. This will be an RFC 4122 compliant UUID.
+    #
+    attr_accessor :agent_uuid
+
+    # @!attribute agent_fname
+    #
+    # @return [string] First name of agent. This can be null if there is no data for this attribute.
+    #
+    attr_accessor :agent_fname
+
+
+    # @!attribute  agent_lname
+    #
+    # @return [string] Last name of agent. This can be null if there is no data for this attribute.
+    #
+    attr_accessor :agent_lname
+
+
+    # @!attribute  title
+    #
+    # @return [string] The title of the presentation. This can be null if there is no data for this attribute.
+    #
+    attr_accessor :title
+
+
+    # @!attribute  created
+    #
+    # @return [string] This is the Unix timestamp for the creation time of the presentation.
+    #
+    attr_accessor :created
+
+
+    # @!attribute  edited
+    #
+    # @return [string] This is the Unix timestamp for the last time the presentation was edited.
+    #
+    attr_accessor :edited
+
+
+    # @!attribute  agent_office_id
+    #
+    # @return [string] This is the ID of the office for the Agent associated with the presentation. This will be an integer.
+    #
+    attr_accessor :agent_office_id
+
+
+    # @!attribute  type
+    #
+    # @return [string] Whether the presentation is for a buyer or seller.
+    #
+    attr_accessor :type
+
+
+    # @!attribute  sent_by_agent
+    #
+    # @return [string] The UUID of the agent that sent the presentation to the client. This will be an RFC 4122 compliant UUID.
+    #
+    attr_accessor :sent_by_agent
+
+
+    # @!attribute  pdf_requested
+    #
+    # @return [string] The number of PDF documents requested.
+    #
+    attr_accessor :pdf_requested
+
+
+    # @!attribute  pres_requested
+    #
+    # @return [string] The number of Online presentations requested.
+    #
+    attr_accessor :pres_requested
+
+
+    # @!attribute  external_identifier
+    #
+    # @return [string] This is the ID of the Agent utilized by their company.
+    #
+    attr_accessor :external_identifier
+
+
+    # @!attribute  external_office_id
+    #
+    # @return [string] This is the ID of the office for this Agent utilized by their company.
+    #
+    attr_accessor :external_office_id
+
+
+    # @!attribute  moxi_works_presentation_id
+    #
+    # @return [string] The unique UUID of the presentation. This will be an RFC 4122 compliant UUID.
+    #
+    attr_accessor :moxi_works_presentation_id
+
+
+
+    # Search For Agents in Moxi Works Platform
+    # @param [Hash] opts named parameter Hash
+    # @option opts [String]  :moxi_works_company_id *REQUIRED* The Moxi Works Company ID For the search (use Company.search to determine available moxi_works_company_id)
+    #
+    #
+    #     optional Search parameters
+    #
+    # @option opts [Integer] :updated_after Unix timestamp representing the start time for the search. If no updated_after parameter is included in the request, only presentations updated in the last seven days will be included in the response.
+    # @option opts [Integer] :updated_before Unix timestamp representing the end time for the search. If no updated_before parameter is included in the request, only presentations updated in the seven days following updated_after will be included in the response.
+    # @option opts [Integer] :created_after Unix timestamp representing the start time for the search.
+    # @option opts [Integer] :created_after  Unix timestamp representing the end time for the search. If no created_before parameter is included in the request, only presentations updated in the seven days following created_after will be included in the response.
+    #
+    # @return [Hash] with the format:
+    #   {
+    #     presentations:  [Array] containing MoxiworkPlatform::PresentationLog objects
+    #   }
+    #
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
+    # @example
+    #     results = MoxiworksPlatform::PresentationLog.search(
+    #     moxi_works_company_id: 'the_company',
+    #     updated_after:  Time.now.to_i - 1296000,
+    #     )
+    #
+    def self.search(opts={})
+      url ||= "#{MoxiworksPlatform::Config.url}/api/presentation_logs"
+      required_opts = [:moxi_works_company_id]
+      required_opts.each do |opt|
+        raise ::MoxiworksPlatform::Exception::ArgumentError, "#{opt} required" if
+            opts[opt].nil? or opts[opt].to_s.empty?
+      end
+
+
+      results = []
+      json = { 'presentations':[]}
+      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['presentations'].each do |r|
+          results << MoxiworksPlatform::PresentationLog.new(r) unless r.nil? or r.empty?
+        end
+        json['presentations'] = results
+      end
+      json
+    end
+
+
+
+  end
+end

data/lib/moxiworks_platform/sold_listing.rb

@@ -0,0 +1,409 @@
+module MoxiworksPlatform
+  # = Moxi Works Platform Listing
+  class SoldListing < MoxiworksPlatform::Resource
+
+    # @!attribute address
+    #
+    # @return [String] street address of property
+    attr_accessor :address
+
+    # @!attribute address2
+    #
+    # @return [String] a second line for street address if needed
+    attr_accessor :address2
+
+    # @!attribute agent_created_listing
+    #
+    # @return [Boolean] whether the agent created the listing
+    attr_accessor :agent_created_listing
+
+    # @!attribute association_fee
+    #
+    # @return [Integer] HOA fees for property
+    attr_accessor :association_fee
+
+    # @!attribute bathrooms_full
+    #
+    # @return [Integer|nil]  number full bathrooms | nil if no data available
+    attr_accessor :bathrooms_full
+
+    # @!attribute bathrooms_half
+    #
+    # @return [Integer|nil] number half bathrooms | nil if no data available
+    attr_accessor :bathrooms_half
+
+    # @!attribute bathrooms_one_quarter
+    #
+    # @return [Integer|nil] number quarter bathrooms | nil if no data available
+    attr_accessor :bathrooms_one_quarter
+
+    # @!attribute bathrooms_partial
+    #
+    # @return [Integer|nil] number partial bathrooms | nil if no data available
+    attr_accessor :bathrooms_partial
+
+    # @!attribute bathrooms_total_integer
+    #
+    # @return [Integer|nil] number of rooms that are bathrooms | nil if no data available
+    attr_accessor :bathrooms_total_integer
+
+    # @!attribute bathrooms_three_quarter
+    #
+    # @return [Integer|nil] number three-quarter bathrooms | nil if no data available
+    attr_accessor :bathrooms_three_quarter
+
+    # @!attribute bathrooms_total
+    #
+    # @return [Integer|nil] number bathrooms | nil if no data available
+    attr_accessor :bathrooms_total
+
+    # @!attribute bedrooms_total
+    #
+    # @return [Integer] number of bedrooms
+    attr_accessor :bedrooms_total
+
+    # @!attribute city
+    #
+    # @return [String] city of property address
+    attr_accessor :city
+
+    # @!attribute county_or_parish
+    #
+    # @return [String] county of property address
+    attr_accessor :county_or_parish
+
+    # @!attribute created_date
+    #
+    # @return [String] string representing date in format 'MM/DD/YYYY'
+    attr_accessor :created_date
+
+    # @!attribute days_on_market
+    #
+    # @return [Integer] days listing has been on market
+    attr_accessor :days_on_market
+
+    # @!attribute elementary_school
+    #
+    # @return [String] elementary school for the property
+    attr_accessor :elementary_school
+
+    # @!attribute garage_spaces
+    #
+    # @return [Integer] garage spaces for the property
+    attr_accessor :garage_spaces
+
+    # @!attribute high_school
+    #
+    # @return [String] High school for property
+    attr_accessor :high_school
+
+    # @!attribute internet_address_display_yn
+    #
+    # @return [Boolean] whether to display the address publicly
+    attr_accessor :internet_address_display_yn
+
+    # @!attribute internet_entire_listing_display_yn
+    #
+    # @return [Boolean] whether to display listing on internet
+    attr_accessor :internet_entire_listing_display_yn
+
+    # @!attribute latitude
+    #
+    # @return [String] latitude of the property
+    attr_accessor :latitude
+
+    # @!attribute list_agent_full_name
+    #
+    # @return [String] name of listing agent
+    attr_accessor :list_agent_full_name
+
+    # @!attribute list_office_name
+    #
+    # @return [String] name office responsible for listing
+    attr_accessor :list_office_name
+
+    # @!attribute list_price
+    #
+    # @return [Integer] listed price
+    attr_accessor :list_price
+
+    # @!attribute list_office_aor
+    #
+    # @return [String] MLS the listing is listed with
+    attr_accessor :list_office_aor
+
+    # @!attribute listing_contract_date
+    #
+    # @return [String] string representing date in format 'MM/DD/YYYY'
+    attr_accessor :listing_contract_date
+
+    # @!attribute listing_id
+    #
+    # @return [String] the mls number associated with the listing
+    attr_accessor :listing_id
+
+    # @!attribute listing_images
+    #
+    # @return [Array] array of image Hashes in the format
+    #  {
+    #     thumb_url: [String] url to thumbail size image (smallest),
+    #     small_url: [String] url to small size image (small),
+    #     full_url: [String] url to full size image (medium),
+    #     gallery_url: [String] url to gallery size image (large),
+    #     raw_url: [String] url to raw image (largest)
+    #     title: [String] human readable title of image
+    #     is_main_listing_image: [Boolean] whether the image is the main image for the listing
+    #     caption: [String] human readable caption for the image
+    #     description: [String] human readable description of the image
+    #     width: [Integer] width of the raw image
+    #     height: [Integer] height of the raw image
+    #     mime_type: [String] MIME or media type of the image
+    #
+    #  }
+    attr_accessor :listing_images
+
+    # @!attribute living_area
+    #
+    # @return [Integer] square footage of the building
+    attr_accessor :living_area
+
+    # @!attribute longitude
+    #
+    # @return [String] longitude of the property
+    attr_accessor :longitude
+
+    # @!attribute lot_size_acres
+    #
+    # @return [float] the property acreage of the listing
+    attr_accessor :lot_size_acres
+
+    # @!attribute lot_size_square_feet
+    #
+    # @return [Integer] square footage of lot
+    attr_accessor :lot_size_square_feet
+
+    # @!attribute middle_or_junior_school
+    #
+    # @return [String] Middle school for property
+    attr_accessor :middle_or_junior_school
+
+    # @!attribute moxi_works_listing_id
+    #   moxi_works_listing_id is the Moxi Works Platform ID of the listing
+    #
+    #   this must be set for any Moxi Works Platform transaction
+    #
+    #   @return [String] the Moxi Works Platform ID of the listing
+    attr_accessor :moxi_works_listing_id
+
+    # @!attribute modification_timestamp
+    #
+    # @return [String] string representing date in format 'MM/DD/YYYY'
+    attr_accessor :modification_timestamp
+
+    # @!attribute on_market
+    #
+    # @return [Boolean] whether the listing is on market
+    attr_accessor :on_market
+
+    # @!attribute pool_yn
+    #
+    # @return [Boolean] whether there is a pool
+    attr_accessor :pool_yn
+
+    # @!attribute postal_code
+    #
+    # @return [String] zip code of property address
+    attr_accessor :postal_code
+
+    # @!attribute property_features
+    #
+    # @return [Hash] property features associated with this listing
+    attr_accessor :property_features
+
+    # @!attribute property_type
+    #
+    # @return [String] type of property, could be 'Rental' 'Residential' 'Condo-Coop' 'Townhouse' 'Land' 'Multifamily'
+    attr_accessor :property_type
+
+    # @!attribute public_remarks
+    #
+    # @return [String] agent generated comments regarding the property
+    attr_accessor :public_remarks
+
+    # @!attribute single_story
+    #
+    # @return [Boolean] whether the building is single story
+    attr_accessor :single_story
+
+    # @!attribute state
+    #
+    # @return [String] state of property address
+    attr_accessor :state_or_province
+
+    # @!attribute tax_annual_amount
+    #
+    # @return [Integer] Annual property tax for the property
+    attr_accessor :tax_annual_amount
+
+    # @!attribute tax_year
+    #
+    # @return [Integer] assessment year that property_tax reflects
+    attr_accessor :tax_year
+
+    # @!attribute view_yn
+    #
+    # @return [Boolean] whether the property has a view
+    attr_accessor :view_yn
+
+    # @!attribute waterfront_yn
+    #
+    # @return [Boolean|nil] whether the property has waterfront acreage
+    attr_accessor :waterfront_yn
+
+    # @!attribute year_built
+    #
+    # @return [Integer] year the building was built
+    attr_accessor :year_built
+
+    # @!attribute sold_date
+    #
+    # @return [String] year the building was built
+    attr_accessor :sold_date
+
+    # @!attribute sold_price
+    #
+    # @return [Integer] price listing was sold for
+    attr_accessor :sold_price
+
+
+    # Find a listing on the  Moxi Works Platform
+    # @param [Hash] opts named parameter Hash
+    # @option opts [String]  :moxi_works_listing_id *REQUIRED* The Moxi Works Listing ID for the listing
+    # @option opts [String]  :moxi_works_company_id *REQUIRED* The Moxi Works Company ID For the search (use Company.search to determine available moxi_works_company_id)
+    #
+    # @return [MoxiworksPlatform::Listing]
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
+    def self.find(opts={})
+      url = "#{MoxiworksPlatform::Config.url}/api/sold_listings/#{opts[:moxi_works_listing_id]}"
+      self.send_request(:get, opts, url)
+    end
+
+    def self.send_request(method, opts={}, url=nil)
+      url ||= "#{MoxiworksPlatform::Config.url}/api/sold_listings"
+      required_opts = [:moxi_works_listing_id, :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
+
+      RestClient::Request.execute(method: method,
+                                  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 = self.underscore_attribute_names json
+        return false if not json['status'].nil? and json['status'] =='fail'
+        self.new(json) unless json.nil? or json.empty?
+      end
+    end
+
+    # Search For Listings in Moxi Works Platform
+    # @param [Hash] opts named parameter Hash
+    # @option opts [String]  :moxi_works_company_id *REQUIRED* The Moxi Works Company ID For the search (use Company.search to determine available moxi_works_company_id)
+    # @option opts [Integer] :sold_since  *REQUIRED*  Unix timestamp; Only Listings updated after this date will be returned
+    # @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) -- only agent_uuid or moxi_works_agent_id are needed when searching for listings by agent
+    # @option opts [String]  :agent_uuid  The Agent UUID For the search (use Agent.search to determine available agent_uuid) -- only agent_uuid or moxi_works_agent_id are needed when searching for listings by agent
+    # @option opts [String]  :moxi_works_office_id  The Moxi Works Office ID For the search (use Office.search or Agent response to determine available moxi_works_office_id)
+    #
+    #
+    #     optional Search parameters
+    #
+    # @option opts [String] :last_moxi_works_listing_id For multi-page responses (where the response value 'last_page' is false), send the listing ID of the last Listing in the previous page.
+    # @option opts [Hash] :previous_page For multi-page responses (where the response value 'last_page' is false), send the entire response from the previous page.
+    #
+    # @return [Hash] with the format:
+    #   {
+    #     last_page: [Boolean],
+    #     listings:  [Array] containing MoxiworkPlatform::Listing objects
+    #   }
+    #
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
+    # @example
+    #     results = MoxiworksPlatform::Listing.search(
+    #     moxi_works_company_id: 'the_company',
+    #     sold_since:  Time.now.to_i - 1296000,
+    #     moxi_works_agent_id: 'abc123'
+    #     )
+    #
+    #     next_page = MoxiworksPlatform::Listing.search(
+    #     moxi_works_company_id: 'the_company',
+    #     sold_since:  Time.now.to_i - 1296000,
+    #     moxi_works_agent_id: 'abc123',
+    #     previous_page: results
+    #     )
+    #
+    # @block |Array|
+    #    if you pass a block with the logic you want to perform on all listings,
+    #    you can have all listings processed in a single call
+    #
+    # @example
+    #     MoxiworksPlatform::Listing.search(
+    #        moxi_works_company_id: 'the_company',
+    #        sold_since: Time.now.to_i - 131297832) { |page_of_listings| puts page_of_listings.count }
+    #
+    def self.search(opts={}, &block)
+      url ||= "#{MoxiworksPlatform::Config.url}/api/sold_listings"
+      required_opts = [:moxi_works_company_id, :sold_since]
+
+      required_opts.each do |opt|
+        raise ::MoxiworksPlatform::Exception::ArgumentError, "#{opt} required" if
+            opts[opt].nil? or opts[opt].to_s.empty?
+      end
+
+      prev_page = opts[:previous_page] || opts['previous_page']
+      unless(prev_page.nil? or
+          prev_page.empty? or
+          not prev_page.is_a?(Hash) or
+          prev_page['listings'].nil? or
+          prev_page['listings'].empty? or
+          not prev_page['listings'].is_a?(Array))
+        opts[:last_moxi_works_listing_id] ||= prev_page['listings'].last.moxi_works_listing_id
+      end
+
+      results = []
+      json = {'listings' => [], 'last_page' => true}
+      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 = self.underscore_attribute_names json
+        json['listings'].each do |r|
+          results << MoxiworksPlatform::Listing.new(r) unless r.nil? or r.empty?
+        end
+        json['listings'] = results
+      end
+      if block_given?
+        yield(json['listings'])
+        unless json['final_page']
+          last_listing = json['listings'].last
+          last_listing_id = (last_listing.nil?) ? nil : last_listing.moxi_works_listing_id
+          MoxiworksPlatform::Listing.search(opts.merge(last_moxi_works_listing_id: last_listing_id), &block) if last_listing_id
+        end
+      end
+      json
+    end
+
+  end
+end
+

data/lib/moxiworks_platform/team.rb

@@ -0,0 +1,208 @@
+module MoxiworksPlatform
+  # = Moxi Works Platform Teams
+  class Team < MoxiworksPlatform::Resource
+
+
+    # @!attribute uuid
+    #
+    # @return string The unique ID of the Team
+    #
+    attr_accessor :uuid
+
+
+    # @!attribute name
+    #
+    # @return string The human readable name of the team
+    #
+    attr_accessor :name
+
+
+    # @!attribute email
+    #
+    # @return string Contact email address for the team
+    #
+    attr_accessor :email
+
+
+    # @!attribute address1
+    #
+    # @return string First line of contact address for the team
+    #
+    attr_accessor :address1
+
+
+    # @!attribute address2
+    #
+    # @return string Second line of contact address for the team
+    #
+    attr_accessor :address2
+
+
+    # @!attribute city
+    #
+    # @return string City portion of contact address for the team
+    #
+    attr_accessor :city
+
+
+    # @!attribute state
+    #
+    # @return string State portion of contact address for the team
+    #
+    attr_accessor :state
+
+
+    # @!attribute zipcode
+    #
+    # @return string Postal Code portion of the contact address for the team
+    #
+    attr_accessor :zipcode
+
+
+    # @!attribute phone
+    #
+    # @return string contact phone number for the team
+    #
+    attr_accessor :phone
+
+
+    # @!attribute fax
+    #
+    # @return string fax number for the team
+    #
+    attr_accessor :fax
+
+
+    # @!attribute logo_url
+    #
+    # @return string URL to a logo image for the team
+    #
+    attr_accessor :logo_url
+
+
+    # @!attribute photo_url
+    #
+    # @return string First URL to a image  representing the team
+    #
+    attr_accessor :photo_url
+
+
+    # @!attribute description
+    #
+    # @return string Description of the team. can contain embedded HTML
+    #
+    attr_accessor :description
+
+
+    # @!attribute social_media_urls
+    #
+    # @return array Social media URLs associated with the team
+    #
+    attr_accessor :social_media_urls
+
+
+    # @!attribute alt_phone
+    #
+    # @return string Alternate contact phone number for the team
+    #
+    attr_accessor :alt_phone
+
+
+    # @!attribute alt_email
+    #
+    # @return string Alternate contact email address for the team
+    #
+    attr_accessor :alt_email
+
+
+    # @!attribute website_url
+    #
+    # @return string URL to the website for the team
+    #
+    attr_accessor :website_url
+
+
+    # @!attribute active
+    #
+    # @return boolean Whether the team is active or not
+    #
+    attr_accessor :active
+
+    # Find a Team by ID in Moxi Works Platform
+    # @param [Hash] opts named parameter Hash
+    # @option opts [String]  :moxi_works_team_id *REQUIRED* The Moxi Works TEam ID
+    #
+    # @return [MoxiworksPlatform::Team]
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
+    def self.find(opts={})
+      raise ::MoxiworksPlatform::Exception::ArgumentError,
+            'arguments must be passed as named parameters' unless opts.is_a? Hash
+      required_opts = [:moxi_works_team_id]
+      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/teams/#{opts[:moxi_works_team_id]}"
+      self.send_request(:get, opts, url)
+    end
+
+    # Search For Teams in Moxi Works Platform
+    # @param [Hash] opts named parameter Hash
+    # @option opts [String]  :moxi_works_company_id *REQUIRED* The Moxi Works Company ID For the search (use Company.search to determine available moxi_works_company_id)
+    #
+    #
+    #     optional Search parameters
+    #
+    #
+    # @return [Array] with the format:
+    #
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
+    # @example
+    #     results = MoxiworksPlatform::Team.search(
+    #     moxi_works_company_id: 'the_company',
+    #     )
+    #
+    #
+    # @block |Array|
+    #    if you pass a block with the logic you want to perform on all teams,
+    #    you can have all teams processed in a single call
+    #
+    # @example
+    #     MoxiworksPlatform::Team.search(
+    #        moxi_works_company_id: 'the_company') { |teams| puts teams.count }
+    #
+    def self.search(opts={})
+      required_opts = [:moxi_works_company_id]
+      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/teams"
+
+      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 = self.underscore_attribute_names json
+        json.each do |r|
+          results << MoxiworksPlatform::Team.new(r) unless r.nil? or r.empty?
+        end
+      end
+      if block_given?
+        yield(results)
+      end
+      results
+    end
+
+  end
+end

data/lib/moxiworks_platform/version.rb

@@ -1,3 +1,3 @@
 module MoxiworksPlatform
-  VERSION = '0.11.3'
+  VERSION = '0.12.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moxiworks_platform
 version: !ruby/object:Gem::Version
-  version: 0.11.3
+  version: 0.12.0
 platform: ruby
 authors:
 - Tres Wong-Godfrey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-29 00:00:00.000000000 Z
+date: 2018-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,13 +94,17 @@ files:
 - lib/moxiworks_platform/email_campaign.rb
 - lib/moxiworks_platform/event.rb
 - lib/moxiworks_platform/exception.rb
+- lib/moxiworks_platform/gallery.rb
 - lib/moxiworks_platform/group.rb
 - lib/moxiworks_platform/listing.rb
 - lib/moxiworks_platform/office.rb
+- lib/moxiworks_platform/presentation_log.rb
 - lib/moxiworks_platform/resource.rb
 - lib/moxiworks_platform/seller_transaction.rb
 - lib/moxiworks_platform/session.rb
+- lib/moxiworks_platform/sold_listing.rb
 - lib/moxiworks_platform/task.rb
+- lib/moxiworks_platform/team.rb
 - lib/moxiworks_platform/version.rb
 - moxiworks_platform.gemspec
 - publish_docs.sh