yext-api 0.1.5 → 0.1.11

data/app/controllers/yext/api/powerlistings/listing_controller.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Yext
+  module Api
+    module Powerlistings
+      # This controller processes Yext listing webhook callbacks.
+      #
+      # The controller will instrument the "listing.powerlistings.yext" ActiveSupport Notification.
+      # The params hash will include:
+      #   * meta    - the `meta` value of the webhook.
+      #   * listing - a Yext::Api::KnowledgeApi::Powerlistings::Listing object that is the Listing
+      #               being reported on.
+
+      # :webhooks:
+      #   :listing:
+      #     :endpoint: https://[your_hostname]/[your_listings_webhook_path]
+      #     :default_version: 20161012
+      #     :documentation: http://developer.yext.com/docs/webhooks/#operation/listingsWebhook
+      #     :sandbox_only: false
+      class ListingController < Yext::Api::ApplicationController
+        extend Memoist
+
+        def create
+          listing = Yext::Api::KnowledgeApi::Powerlistings::Listing.new(listing_hash[:listing])
+
+          ActiveSupport::Notifications.instrument "listing.powerlistings.yext",
+                                                  meta:    listing_hash[:meta],
+                                                  listing: listing do
+            # do your custom stuff here
+          end
+
+          head :ok
+        end
+
+        private
+
+        # rubocop:disable MethodLength
+
+        def listing_hash
+          params.
+              permit(meta:    %i[eventType uuid timestamp accountId actor appSpecificAccountId],
+                     listing: [:id,
+                               :locationId,
+                               :publisherId,
+                               :status,
+                               :additionalStatus,
+                               :listingUrl,
+                               :loginUrl,
+                               :screenshotUrl,
+                               { statusDetails: %i[code message type] },
+                               { alternateBrands: %i[brandName listingUrl] }]).
+              to_hash.
+              with_indifferent_access
+        end
+
+        # rubocop:enable MethodLength
+
+        memoize :listing_hash
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -4,4 +4,8 @@ Yext::Api::Engine.routes.draw do
   scope :agreements, module: :agreements do
     resources :add_request, only: %i[create]
   end
+
+  scope :powerlistings, module: :powerlistings do
+    resources :listing, only: %i[create]
+  end
 end

data/lib/config/api.yml

@@ -420,9 +420,9 @@
             :documentation: http://developer.yext.com/docs/api-reference/#operation/deleteAsset
             :sandbox_only: false
   :power_listings:
-    :module_name: PowerListings
+    :module_name: Powerlistings
     :objects:
-      :publishser:
+      :publisher:
         :actions:
           - :action: :index
             :method: :get

data/lib/yext-api.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "spyke"
+require "memoist"
+require "validation"
+require "validation/validator"
+require "validation/rule/not_empty"
+require "yext/api"
+require "yext/api/engine"
+require "yext/api/concerns/enum_all"
+require "yext/api/enumerations/add_request_location_mode"
+require "yext/api/enumerations/add_request_status"
+require "yext/api/enumerations/error_codes/agreements_errors"
+require "yext/api/enumerations/error_codes/analytics_errors"
+require "yext/api/enumerations/error_codes/customers_errros"
+require "yext/api/enumerations/error_codes/ecl_errors"
+require "yext/api/enumerations/error_codes/feedback_errors"
+require "yext/api/enumerations/error_codes/general_errors"
+require "yext/api/enumerations/error_codes/live_api_errors"
+require "yext/api/enumerations/error_codes/locations_errors"
+require "yext/api/enumerations/error_codes/optimizations_errors"
+require "yext/api/enumerations/error_codes/publisher_suggestions_errors"
+require "yext/api/enumerations/error_codes/reviews_errors"
+require "yext/api/enumerations/error_codes/social_errors"
+require "yext/api/enumerations/error_codes/subscriptions_errors"
+require "yext/api/enumerations/error_codes/suppression_errors"
+require "yext/api/enumerations/error_codes/users_errors"
+require "yext/api/enumerations/error_codes"
+require "yext/api/enumerations/listing_status"
+require "yext/api/enumerations/location_type"
+require "yext/api/enumerations/optimization_link_mode"
+require "yext/api/enumerations/validation"
+require "yext/api/utils/configuration"
+require "yext/api/concerns/rate_limits"
+require "yext/api/live_api"
+require "yext/api/utils/api_finder"
+require "yext/api/utils/middleware/api_rate_limits"
+require "yext/api/utils/middleware/default_parameters"
+require "yext/api/utils/middleware/response_parser"
+require "yext/api/utils/middleware/uri_cleanup"
+require "yext/api/concerns/faraday_connection"
+require "yext/api/concerns/default_scopes"
+require "yext/api/utils/api_base"
+require "yext/api/concerns/account_child"
+require "yext/api/concerns/account_relations"
+require "yext/api/knowledge_api"
+require "yext/api/knowledge_api/account_settings/account"
+require "yext/api/administrative_api"
+require "yext/api/administrative_api/account"
+require "yext/api/live_api/location"
+require "yext/api/validators/account_validator"
+require "yext/api/administrative_api/add_request"
+require "yext/api/administrative_api/service"
+require "yext/api/knowledge_api/account_settings/role"
+require "yext/api/knowledge_api/account_settings/user"
+require "yext/api/knowledge_api/health_check/health"
+require "yext/api/knowledge_api/knowledge_manager/category"
+require "yext/api/knowledge_api/knowledge_manager/location"
+require "yext/api/knowledge_api/optimization_tasks/optimization_link"
+require "yext/api/knowledge_api/optimization_tasks/optimization_task"
+require "yext/api/knowledge_api/powerlistings/listing"
+require "yext/api/knowledge_api/powerlistings/publisher"
+require_relative "../app/controllers/yext/api/application_controller"
+require_relative "../app/controllers/yext/api/agreements/add_request_controller"
+require_relative "../app/controllers/yext/api/powerlistings/listing_controller"

data/lib/yext/api/administrative_api/account.rb

@@ -30,8 +30,6 @@ module Yext
       class Account < Yext::Api::Utils::ApiBase
         include Yext::Api::Concerns::AccountRelations
 
-        after_save :save_account_id
-
         # The save action only allows the saving of the account_id and the accountName
         #
         # Furthermore, the account_id cannot be changed by the partner, but only by the customer
@@ -48,24 +46,6 @@ module Yext
 
           save_account_id
         end
-
-        # rubocop:disable Naming/MethodName
-
-        # Yext field names don't match the Ruby naming standard, this is the field name they use.
-        # Because I use `account_id` in the route, I need that attribute defined.  Because
-        # Yext uses accountId, when it is set, I need to set `account_id` so they will match.
-        def accountId=(value)
-          super
-          attributes[:account_id] ||= value
-        end
-
-        # rubocop:enable Naming/MethodName
-
-        private
-
-        def save_account_id
-          attributes[:account_id] = accountId
-        end
       end
     end
   end

data/lib/yext/api/administrative_api/add_request.rb

@@ -47,6 +47,19 @@ module Yext
 
         include Yext::Api::Concerns::AccountChild
 
+        # rubocop:disable Naming/MethodName
+
+        # helper function to extract the affected location ID based on the locationMode
+        def locationId
+          if locationMode == Yext::Api::Enumerations::AddRequestLocationMode::NEW
+            newLocationId
+          else
+            existingLocationId
+          end
+        end
+
+        # rubocop:enable Naming/MethodName
+
         # This is a helper method to try to simplify changing the status of an AddRequest if you
         # don't have an AddRequest object.
         #
@@ -89,6 +102,8 @@ module Yext
               post
         end)
 
+        # After successfully creating a new add request, the object attributes will be updated/
+        # changed to the values of the created add request.
         def save
           if persisted?
             change_status
@@ -104,6 +119,12 @@ module Yext
               with(Yext::Api::Concerns::AccountChild.with_account_path("newlocationaddrequests")).
               where(attributes.reverse_merge(account_id: Yext::Api.configuration.param_account_id)).
               post
+
+          if Yext::Api::AdministrativeApi.last_status.between?(200, 299)
+            self.attributes = Yext::Api::AdministrativeApi.last_data.dup
+          else
+            self
+          end
         end
 
         def change_status

data/lib/yext/api/concerns/account_child.rb

@@ -25,10 +25,12 @@ module Yext
           end
 
           def ensure_relation(klass)
-            [Yext::Api::KnowledgeApi::AccountSettings::Account, Yext::Api::AdministrativeApi::Account].each do |account_class|
+            %w[Yext::Api::KnowledgeApi::AccountSettings::Account Yext::Api::AdministrativeApi::Account].each do |account_class_name|
+              account_class = account_class_name.constantize
               next if account_class.association?(klass)
 
               klass_uri = klass.instance_variable_get(:@uri)
+
               klass_uri ||= klass.send(:default_uri)
               helper_warnings(account_class, klass, klass_uri)
 
@@ -79,6 +81,8 @@ module Yext
           end)
 
           Yext::Api::Concerns::AccountChild.ensure_relation(self)
+
+          after_save :save_account_id
         end
 
         class_methods do
@@ -110,11 +114,31 @@ module Yext
 
             args[:account_id] ||= Yext::Api.configuration.param_account_id
 
-            args[:id] = args.delete(:account_id) if account_scope
+            # account_scope means that the scope will be applied to an Account rather than a
+            # relation off of an Account.
+            args[:id]         = args.delete(:account_id) if account_scope
 
             args
           end
         end
+
+        # rubocop:disable Naming/MethodName
+
+        # Yext field names don't match the Ruby naming standard, this is the field name they use.
+        # Because I use `account_id` in the route, I need that attribute defined.  Because
+        # Yext uses accountId, when it is set, I need to set `account_id` so they will match.
+        def accountId=(value)
+          super
+          attributes[:account_id] = value
+        end
+
+        # rubocop:enable Naming/MethodName
+
+        private
+
+        def save_account_id
+          attributes[:account_id] = attributes[:accountId] if attributes.key?(:accountId)
+        end
       end
     end
   end

data/lib/yext/api/concerns/account_relations.rb

@@ -34,8 +34,36 @@ module Yext
                    class_name: "Yext::Api::KnowledgeApi::OptimizationTasks::OptimizationLink",
                    uri:        Yext::Api::Concerns::AccountChild.with_account_path("optimizationlink")
 
+          # KnowledgeApi::Powerlistings
+          has_many :listings,
+                   class_name: "Yext::Api::KnowledgeApi::Powerlistings::Listing",
+                   uri:        Yext::Api::Concerns::AccountChild.with_account_path("powerlistings/listings/(:id)")
+          has_many :publishers,
+                   class_name: "Yext::Api::KnowledgeApi::Powerlistings::Publisher",
+                   uri:        Yext::Api::Concerns::AccountChild.with_account_path("powerlistings/publishers/(:id)")
+
           # LiveApi
           has_many :live_locations, class_name: "Yext::Api::LiveApi::Location"
+
+          after_save :save_account_id
+        end
+
+        # rubocop:disable Naming/MethodName
+
+        # Yext field names don't match the Ruby naming standard, this is the field name they use.
+        # Because I use `account_id` in the route, I need that attribute defined.  Because
+        # Yext uses accountId, when it is set, I need to set `account_id` so they will match.
+        def accountId=(value)
+          super
+          attributes[:account_id] ||= value
+        end
+
+        # rubocop:enable Naming/MethodName
+
+        private
+
+        def save_account_id
+          attributes[:account_id] = accountId
         end
 
         class_methods do

data/lib/yext/api/enumerations/add_request_location_mode.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Yext
+  module Api
+    module Enumerations
+      # The type of the location in an AddRequest
+      class AddRequestLocationMode
+        include Yext::Api::Concerns::EnumAll
+
+        EXISTING = "EXISTING"
+        NEW      = "NEW"
+      end
+    end
+  end
+end

data/lib/yext/api/enumerations/listing_status.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Yext
+  module Api
+    module Enumerations
+      # An enumeration class to contain the possible status values for a listing.
+      class ListingStatus
+        include Yext::Api::Concerns::EnumAll
+
+        WAITING_ON_YEXT      = "WAITING_ON_YEXT"
+        WAITING_ON_CUSTOMER  = "WAITING_ON_CUSTOMER"
+        WAITING_ON_PUBLISHER = "WAITING_ON_PUBLISHER"
+        LIVE                 = "LIVE"
+        UNAVAILABLE          = "UNAVAILABLE"
+        OPTED_OUT            = "OPTED_OUT"
+      end
+    end
+  end
+end

data/lib/yext/api/enumerations/optimization_link_mode.rb

@@ -3,6 +3,7 @@
 module Yext
   module Api
     module Enumerations
+      # The possible modes to search for when looking up Optimization Links
       class OptimizationLinkMode
         include Yext::Api::Concerns::EnumAll
 

data/lib/yext/api/knowledge_api/knowledge_manager/location.rb

@@ -46,6 +46,30 @@ module Yext
         class Location < Yext::Api::Utils::ApiBase
           include Yext::Api::Concerns::AccountChild
 
+          scope(:search, lambda do |*filters|
+            args           = scope_args true
+            args[:filters] = Array.wrap(filters).to_json
+
+            Yext::Api::AdministrativeApi::Account.
+                where(args).
+                with(:locationsearch).
+                get
+          end)
+
+          def save(*fields_to_update)
+            return super if fields_to_update.blank?
+
+            # To save only certain fields, slice those fields into a new Location so that everything
+            # is sent (which is only the fields we want)
+            location = Yext::Api::KnowledgeApi::KnowledgeManager::Location.
+                new(attributes.with_indifferent_access.slice(*fields_to_update))
+
+            location.id        = id
+            location.accountId = accountId
+
+            location.save
+          end
+
           # http://developer.yext.com/docs/administrative-api/#operation/createExistingLocationAddRequest
           def add_services!(skus:, agreement_id: nil, force_review: false)
             args               = { existingAccountId: account_id, existingLocationId: id }

data/lib/yext/api/knowledge_api/powerlistings/listing.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Yext
+  module Api
+    module KnowledgeApi
+      module Powerlistings
+        # :knowledge_api:
+        #   :powerlistings:
+        #     :listing:
+        #       - :action: :index
+        #         :method: :get
+        #         :endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/listings
+        #         :path_regex: v2/accounts/[^/]+?/powerlistings/listings
+        #         :default_version: 20161012
+        #         :documentation: http://developer.yext.com/docs/api-reference/#operation/listListings
+        #         :sandbox_only: false
+        #       - :action: :opt_in
+        #         :method: :put
+        #         :endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/listings/optin
+        #         :path_regex: v2/accounts/[^/]+?/powerlistings/listings/optin
+        #         :default_version: 20161012
+        #         :documentation: http://developer.yext.com/docs/api-reference/#operation/optInListings
+        #         :sandbox_only: false
+        #       - :action: :opt_out
+        #         :method: :put
+        #         :endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/listings/optout
+        #         :path_regex: v2/accounts/[^/]+?/powerlistings/listings/optout
+        #         :default_version: 20161012
+        #         :documentation: http://developer.yext.com/docs/api-reference/#operation/optOutListings
+        #         :sandbox_only: false
+        class Listing < Yext::Api::Utils::ApiBase
+          uri "powerlistings/#{default_uri}"
+
+          include Yext::Api::Concerns::AccountChild
+
+          # rubocop:disable Style/Lambda
+
+          scope(:opt_in!, ->(location_ids: nil, publisher_ids: nil) do
+            params                = {}
+            params[:locationIds]  = Array.wrap(location_ids).join(",") if location_ids.present?
+            params[:publisherIds] = Array.wrap(publisher_ids).join(",") if publisher_ids.present?
+
+            where(params).with(:optin).put
+          end)
+
+          scope(:opt_out!, ->(location_ids: nil, publisher_ids: nil) do
+            params                = {}
+            params[:locationIds]  = Array.wrap(location_ids) if location_ids.present?
+            params[:publisherIds] = Array.wrap(publisher_ids) if publisher_ids.present?
+
+            where(params).with(:optout).put
+          end)
+
+          # rubocop:enable Style/Lambda
+        end
+      end
+    end
+  end
+end