diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,367 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# gogol-freebasesearch + +* [Version](#version) +* [Description](#description) +* [Contribute](#contribute) +* [Licence](#licence) + + +## Version + +`0.0.1` + + +## Description + +A client library for the Google Freebase Search. + + +## Contribute + +For any problems, comments, or feedback please create an issue [here on GitHub](https://github.com/brendanhay/amazonka/issues). + +> _Note:_ this library is an auto-generated Haskell package. Please see `amazonka-gen` for more information. + + +## Licence + +`gogol-freebasesearch` is released under the [Mozilla Public License Version 2.0](http://www.mozilla.org/MPL/). diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/gen/Network/Google/FreebaseSearch.hs b/gen/Network/Google/FreebaseSearch.hs new file mode 100644 --- /dev/null +++ b/gen/Network/Google/FreebaseSearch.hs @@ -0,0 +1,100 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE TypeOperators #-} + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} +{-# OPTIONS_GHC -fno-warn-duplicate-exports #-} + +-- | +-- Module : Network.Google.FreebaseSearch +-- Copyright : (c) 2015 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +-- Find Freebase entities using textual queries and other constraints. +-- +-- /See:/ +module Network.Google.FreebaseSearch + ( + -- * Service Configuration + freebaseSearchService + + -- * API Declaration + , FreebaseSearchAPI + + -- * Methods + + -- ** freebase.reconcile + , module Network.Google.Method.Freebase.Reconcile + + -- ** freebase.search + , module Network.Google.Method.Freebase.Search + + -- * Types + + -- ** FreebaseSearchFormat + , FreebaseSearchFormat (..) + + -- ** ReconcileGetWarningItem + , ReconcileGetWarningItem + , reconcileGetWarningItem + , rgwiLocation + , rgwiReason + , rgwiMessage + + -- ** FreebaseSearchScoring + , FreebaseSearchScoring (..) + + -- ** ReconcileGetCosts + , ReconcileGetCosts + , reconcileGetCosts + , rgcHits + , rgcMs + + -- ** ReconcileGet + , ReconcileGet + , reconcileGet + , rgCandidate + , rgCosts + , rgWarning + , rgMatch + + -- ** FreebaseSearchEncode + , FreebaseSearchEncode (..) + + -- ** ReconcileCandidateNotable + , ReconcileCandidateNotable + , reconcileCandidateNotable + , rcnName + , rcnId + + -- ** ReconcileCandidate + , ReconcileCandidate + , reconcileCandidate + , rcLang + , rcConfidence + , rcName + , rcNotable + , rcMid + + -- ** FreebaseSearchHelp + , FreebaseSearchHelp (..) + + -- ** FreebaseSearchSpell + , FreebaseSearchSpell (..) + ) where + +import Network.Google.FreebaseSearch.Types +import Network.Google.Method.Freebase.Reconcile +import Network.Google.Method.Freebase.Search +import Network.Google.Prelude + +{- $resources +TODO +-} + +-- | Represents the entirety of the methods and resources available for the Freebase Search service. +type FreebaseSearchAPI = + ReconcileMethod :<|> SearchMethod diff --git a/gen/Network/Google/FreebaseSearch/Types.hs b/gen/Network/Google/FreebaseSearch/Types.hs new file mode 100644 --- /dev/null +++ b/gen/Network/Google/FreebaseSearch/Types.hs @@ -0,0 +1,81 @@ +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE OverloadedStrings #-} + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} + +-- | +-- Module : Network.Google.FreebaseSearch.Types +-- Copyright : (c) 2015 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +module Network.Google.FreebaseSearch.Types + ( + -- * Service Configuration + freebaseSearchService + + -- * FreebaseSearchFormat + , FreebaseSearchFormat (..) + + -- * ReconcileGetWarningItem + , ReconcileGetWarningItem + , reconcileGetWarningItem + , rgwiLocation + , rgwiReason + , rgwiMessage + + -- * FreebaseSearchScoring + , FreebaseSearchScoring (..) + + -- * ReconcileGetCosts + , ReconcileGetCosts + , reconcileGetCosts + , rgcHits + , rgcMs + + -- * ReconcileGet + , ReconcileGet + , reconcileGet + , rgCandidate + , rgCosts + , rgWarning + , rgMatch + + -- * FreebaseSearchEncode + , FreebaseSearchEncode (..) + + -- * ReconcileCandidateNotable + , ReconcileCandidateNotable + , reconcileCandidateNotable + , rcnName + , rcnId + + -- * ReconcileCandidate + , ReconcileCandidate + , reconcileCandidate + , rcLang + , rcConfidence + , rcName + , rcNotable + , rcMid + + -- * FreebaseSearchHelp + , FreebaseSearchHelp (..) + + -- * FreebaseSearchSpell + , FreebaseSearchSpell (..) + ) where + +import Network.Google.FreebaseSearch.Types.Product +import Network.Google.FreebaseSearch.Types.Sum +import Network.Google.Prelude + +-- | Default request referring to version 'v1' of the Freebase Search. This contains the host and root path used as a starting point for constructing service requests. +freebaseSearchService :: Service +freebaseSearchService + = defaultService (ServiceId "freebase:v1") + "www.googleapis.com" diff --git a/gen/Network/Google/FreebaseSearch/Types/Product.hs b/gen/Network/Google/FreebaseSearch/Types/Product.hs new file mode 100644 --- /dev/null +++ b/gen/Network/Google/FreebaseSearch/Types/Product.hs @@ -0,0 +1,326 @@ +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RecordWildCards #-} + +{-# OPTIONS_GHC -fno-warn-unused-binds #-} +{-# OPTIONS_GHC -fno-warn-unused-imports #-} + +-- | +-- Module : Network.Google.FreebaseSearch.Types.Product +-- Copyright : (c) 2015 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +module Network.Google.FreebaseSearch.Types.Product where + +import Network.Google.FreebaseSearch.Types.Sum +import Network.Google.Prelude + +-- +-- /See:/ 'reconcileGetWarningItem' smart constructor. +data ReconcileGetWarningItem = ReconcileGetWarningItem + { _rgwiLocation :: !(Maybe Text) + , _rgwiReason :: !(Maybe Text) + , _rgwiMessage :: !(Maybe Text) + } deriving (Eq,Show,Data,Typeable,Generic) + +-- | Creates a value of 'ReconcileGetWarningItem' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'rgwiLocation' +-- +-- * 'rgwiReason' +-- +-- * 'rgwiMessage' +reconcileGetWarningItem + :: ReconcileGetWarningItem +reconcileGetWarningItem = + ReconcileGetWarningItem + { _rgwiLocation = Nothing + , _rgwiReason = Nothing + , _rgwiMessage = Nothing + } + +-- | Location of warning in the request e.g. invalid predicate. +rgwiLocation :: Lens' ReconcileGetWarningItem (Maybe Text) +rgwiLocation + = lens _rgwiLocation (\ s a -> s{_rgwiLocation = a}) + +-- | Code for identifying classes of warnings. +rgwiReason :: Lens' ReconcileGetWarningItem (Maybe Text) +rgwiReason + = lens _rgwiReason (\ s a -> s{_rgwiReason = a}) + +-- | Warning message to display to the user. +rgwiMessage :: Lens' ReconcileGetWarningItem (Maybe Text) +rgwiMessage + = lens _rgwiMessage (\ s a -> s{_rgwiMessage = a}) + +instance FromJSON ReconcileGetWarningItem where + parseJSON + = withObject "ReconcileGetWarningItem" + (\ o -> + ReconcileGetWarningItem <$> + (o .:? "location") <*> (o .:? "reason") <*> + (o .:? "message")) + +instance ToJSON ReconcileGetWarningItem where + toJSON ReconcileGetWarningItem{..} + = object + (catMaybes + [("location" .=) <$> _rgwiLocation, + ("reason" .=) <$> _rgwiReason, + ("message" .=) <$> _rgwiMessage]) + +-- | Server costs for reconciling. +-- +-- /See:/ 'reconcileGetCosts' smart constructor. +data ReconcileGetCosts = ReconcileGetCosts + { _rgcHits :: !(Maybe (Textual Int32)) + , _rgcMs :: !(Maybe (Textual Int32)) + } deriving (Eq,Show,Data,Typeable,Generic) + +-- | Creates a value of 'ReconcileGetCosts' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'rgcHits' +-- +-- * 'rgcMs' +reconcileGetCosts + :: ReconcileGetCosts +reconcileGetCosts = + ReconcileGetCosts + { _rgcHits = Nothing + , _rgcMs = Nothing + } + +-- | Total number of hits found. +rgcHits :: Lens' ReconcileGetCosts (Maybe Int32) +rgcHits + = lens _rgcHits (\ s a -> s{_rgcHits = a}) . + mapping _Coerce + +-- | Total milliseconds spent. +rgcMs :: Lens' ReconcileGetCosts (Maybe Int32) +rgcMs + = lens _rgcMs (\ s a -> s{_rgcMs = a}) . + mapping _Coerce + +instance FromJSON ReconcileGetCosts where + parseJSON + = withObject "ReconcileGetCosts" + (\ o -> + ReconcileGetCosts <$> + (o .:? "hits") <*> (o .:? "ms")) + +instance ToJSON ReconcileGetCosts where + toJSON ReconcileGetCosts{..} + = object + (catMaybes + [("hits" .=) <$> _rgcHits, ("ms" .=) <$> _rgcMs]) + +-- +-- /See:/ 'reconcileGet' smart constructor. +data ReconcileGet = ReconcileGet + { _rgCandidate :: !(Maybe [ReconcileCandidate]) + , _rgCosts :: !(Maybe ReconcileGetCosts) + , _rgWarning :: !(Maybe [ReconcileGetWarningItem]) + , _rgMatch :: !(Maybe ReconcileCandidate) + } deriving (Eq,Show,Data,Typeable,Generic) + +-- | Creates a value of 'ReconcileGet' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'rgCandidate' +-- +-- * 'rgCosts' +-- +-- * 'rgWarning' +-- +-- * 'rgMatch' +reconcileGet + :: ReconcileGet +reconcileGet = + ReconcileGet + { _rgCandidate = Nothing + , _rgCosts = Nothing + , _rgWarning = Nothing + , _rgMatch = Nothing + } + +-- | If filled, then the listed candidates are potential matches, and such +-- should be evaluated by a more discerning algorithm or human. The matches +-- are ordered by confidence. +rgCandidate :: Lens' ReconcileGet [ReconcileCandidate] +rgCandidate + = lens _rgCandidate (\ s a -> s{_rgCandidate = a}) . + _Default + . _Coerce + +-- | Server costs for reconciling. +rgCosts :: Lens' ReconcileGet (Maybe ReconcileGetCosts) +rgCosts = lens _rgCosts (\ s a -> s{_rgCosts = a}) + +-- | If filled, then there were recoverable problems that affected the +-- request. For example, some of the properties were ignored because they +-- either are not valid Freebase predicates or are not indexed for +-- reconciliation. The candidates returned should be considered valid +-- results, with the caveat that sections of the request were ignored as +-- specified by the warning text. +rgWarning :: Lens' ReconcileGet [ReconcileGetWarningItem] +rgWarning + = lens _rgWarning (\ s a -> s{_rgWarning = a}) . + _Default + . _Coerce + +-- | If filled, this entity is guaranteed to match at requested confidence +-- probability (default 99%). +rgMatch :: Lens' ReconcileGet (Maybe ReconcileCandidate) +rgMatch = lens _rgMatch (\ s a -> s{_rgMatch = a}) + +instance FromJSON ReconcileGet where + parseJSON + = withObject "ReconcileGet" + (\ o -> + ReconcileGet <$> + (o .:? "candidate" .!= mempty) <*> (o .:? "costs") + <*> (o .:? "warning" .!= mempty) + <*> (o .:? "match")) + +instance ToJSON ReconcileGet where + toJSON ReconcileGet{..} + = object + (catMaybes + [("candidate" .=) <$> _rgCandidate, + ("costs" .=) <$> _rgCosts, + ("warning" .=) <$> _rgWarning, + ("match" .=) <$> _rgMatch]) + +-- | Type or profession the candidate is notable for. +-- +-- /See:/ 'reconcileCandidateNotable' smart constructor. +data ReconcileCandidateNotable = ReconcileCandidateNotable + { _rcnName :: !(Maybe Text) + , _rcnId :: !(Maybe Text) + } deriving (Eq,Show,Data,Typeable,Generic) + +-- | Creates a value of 'ReconcileCandidateNotable' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'rcnName' +-- +-- * 'rcnId' +reconcileCandidateNotable + :: ReconcileCandidateNotable +reconcileCandidateNotable = + ReconcileCandidateNotable + { _rcnName = Nothing + , _rcnId = Nothing + } + +-- | Name of notable category in specified language. +rcnName :: Lens' ReconcileCandidateNotable (Maybe Text) +rcnName = lens _rcnName (\ s a -> s{_rcnName = a}) + +-- | MID of notable category. +rcnId :: Lens' ReconcileCandidateNotable (Maybe Text) +rcnId = lens _rcnId (\ s a -> s{_rcnId = a}) + +instance FromJSON ReconcileCandidateNotable where + parseJSON + = withObject "ReconcileCandidateNotable" + (\ o -> + ReconcileCandidateNotable <$> + (o .:? "name") <*> (o .:? "id")) + +instance ToJSON ReconcileCandidateNotable where + toJSON ReconcileCandidateNotable{..} + = object + (catMaybes + [("name" .=) <$> _rcnName, ("id" .=) <$> _rcnId]) + +-- +-- /See:/ 'reconcileCandidate' smart constructor. +data ReconcileCandidate = ReconcileCandidate + { _rcLang :: !(Maybe Text) + , _rcConfidence :: !(Maybe (Textual Double)) + , _rcName :: !(Maybe Text) + , _rcNotable :: !(Maybe ReconcileCandidateNotable) + , _rcMid :: !(Maybe Text) + } deriving (Eq,Show,Data,Typeable,Generic) + +-- | Creates a value of 'ReconcileCandidate' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'rcLang' +-- +-- * 'rcConfidence' +-- +-- * 'rcName' +-- +-- * 'rcNotable' +-- +-- * 'rcMid' +reconcileCandidate + :: ReconcileCandidate +reconcileCandidate = + ReconcileCandidate + { _rcLang = Nothing + , _rcConfidence = Nothing + , _rcName = Nothing + , _rcNotable = Nothing + , _rcMid = Nothing + } + +-- | Language code that candidate and notable names are displayed in. +rcLang :: Lens' ReconcileCandidate (Maybe Text) +rcLang = lens _rcLang (\ s a -> s{_rcLang = a}) + +-- | Percentage likelihood that this candidate is the unique matching entity. +-- Value will be between 0.0 and 1.0 +rcConfidence :: Lens' ReconcileCandidate (Maybe Double) +rcConfidence + = lens _rcConfidence (\ s a -> s{_rcConfidence = a}) + . mapping _Coerce + +-- | Freebase name of matching entity in specified language. +rcName :: Lens' ReconcileCandidate (Maybe Text) +rcName = lens _rcName (\ s a -> s{_rcName = a}) + +-- | Type or profession the candidate is notable for. +rcNotable :: Lens' ReconcileCandidate (Maybe ReconcileCandidateNotable) +rcNotable + = lens _rcNotable (\ s a -> s{_rcNotable = a}) + +-- | Freebase MID of candidate entity. +rcMid :: Lens' ReconcileCandidate (Maybe Text) +rcMid = lens _rcMid (\ s a -> s{_rcMid = a}) + +instance FromJSON ReconcileCandidate where + parseJSON + = withObject "ReconcileCandidate" + (\ o -> + ReconcileCandidate <$> + (o .:? "lang") <*> (o .:? "confidence") <*> + (o .:? "name") + <*> (o .:? "notable") + <*> (o .:? "mid")) + +instance ToJSON ReconcileCandidate where + toJSON ReconcileCandidate{..} + = object + (catMaybes + [("lang" .=) <$> _rcLang, + ("confidence" .=) <$> _rcConfidence, + ("name" .=) <$> _rcName, + ("notable" .=) <$> _rcNotable, + ("mid" .=) <$> _rcMid]) diff --git a/gen/Network/Google/FreebaseSearch/Types/Sum.hs b/gen/Network/Google/FreebaseSearch/Types/Sum.hs new file mode 100644 --- /dev/null +++ b/gen/Network/Google/FreebaseSearch/Types/Sum.hs @@ -0,0 +1,205 @@ +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE LambdaCase #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE OverloadedStrings #-} + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} + +-- | +-- Module : Network.Google.FreebaseSearch.Types.Sum +-- Copyright : (c) 2015 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +module Network.Google.FreebaseSearch.Types.Sum where + +import Network.Google.Prelude + +-- | Structural format of the json response. +data FreebaseSearchFormat + = AC + -- ^ @ac@ + -- Compact format useful for autocomplete\/suggest UIs. + | Classic + -- ^ @classic@ + -- [DEPRECATED] Same format as was returned by api.freebase.com. + | Entity + -- ^ @entity@ + -- Basic information about the entities. + | Guids + -- ^ @guids@ + -- [DEPRECATED] Ordered list of a freebase guids. + | Ids + -- ^ @ids@ + -- Ordered list of freebase ids. + | Mids + -- ^ @mids@ + -- Ordered list of freebase mids. + deriving (Eq,Ord,Enum,Read,Show,Data,Typeable,Generic) + +instance Hashable FreebaseSearchFormat + +instance FromText FreebaseSearchFormat where + fromText = \case + "ac" -> Just AC + "classic" -> Just Classic + "entity" -> Just Entity + "guids" -> Just Guids + "ids" -> Just Ids + "mids" -> Just Mids + _ -> Nothing + +instance ToText FreebaseSearchFormat where + toText = \case + AC -> "ac" + Classic -> "classic" + Entity -> "entity" + Guids -> "guids" + Ids -> "ids" + Mids -> "mids" + +instance FromJSON FreebaseSearchFormat where + parseJSON = parseJSONText "FreebaseSearchFormat" + +instance ToJSON FreebaseSearchFormat where + toJSON = toJSONText + +-- | Relevance scoring algorithm to use. +data FreebaseSearchScoring + = FSSEntity + -- ^ @entity@ + -- Use freebase and popularity entity ranking. + | FSSFreebase + -- ^ @freebase@ + -- Use freebase entity ranking. + | FSSSchema + -- ^ @schema@ + -- Use schema ranking for properties and types. + deriving (Eq,Ord,Enum,Read,Show,Data,Typeable,Generic) + +instance Hashable FreebaseSearchScoring + +instance FromText FreebaseSearchScoring where + fromText = \case + "entity" -> Just FSSEntity + "freebase" -> Just FSSFreebase + "schema" -> Just FSSSchema + _ -> Nothing + +instance ToText FreebaseSearchScoring where + toText = \case + FSSEntity -> "entity" + FSSFreebase -> "freebase" + FSSSchema -> "schema" + +instance FromJSON FreebaseSearchScoring where + parseJSON = parseJSONText "FreebaseSearchScoring" + +instance ToJSON FreebaseSearchScoring where + toJSON = toJSONText + +-- | The encoding of the response. You can use this parameter to enable html +-- encoding. +data FreebaseSearchEncode + = HTML + -- ^ @html@ + -- Encode certain characters in the response (such as tags and ambersands) + -- using html encoding. + | Off + -- ^ @off@ + -- No encoding of the response. You should not print the results directly + -- on an web page without html-escaping the content first. + deriving (Eq,Ord,Enum,Read,Show,Data,Typeable,Generic) + +instance Hashable FreebaseSearchEncode + +instance FromText FreebaseSearchEncode where + fromText = \case + "html" -> Just HTML + "off" -> Just Off + _ -> Nothing + +instance ToText FreebaseSearchEncode where + toText = \case + HTML -> "html" + Off -> "off" + +instance FromJSON FreebaseSearchEncode where + parseJSON = parseJSONText "FreebaseSearchEncode" + +instance ToJSON FreebaseSearchEncode where + toJSON = toJSONText + +-- | The keyword to request help on. +data FreebaseSearchHelp + = Langs + -- ^ @langs@ + -- The language codes served by the service. + | MAppings + -- ^ @mappings@ + -- The property\/path mappings supported by the filter and output request + -- parameters. + | Predicates + -- ^ @predicates@ + -- The predicates and path-terminating properties supported by the filter + -- and output request parameters. + deriving (Eq,Ord,Enum,Read,Show,Data,Typeable,Generic) + +instance Hashable FreebaseSearchHelp + +instance FromText FreebaseSearchHelp where + fromText = \case + "langs" -> Just Langs + "mappings" -> Just MAppings + "predicates" -> Just Predicates + _ -> Nothing + +instance ToText FreebaseSearchHelp where + toText = \case + Langs -> "langs" + MAppings -> "mappings" + Predicates -> "predicates" + +instance FromJSON FreebaseSearchHelp where + parseJSON = parseJSONText "FreebaseSearchHelp" + +instance ToJSON FreebaseSearchHelp where + toJSON = toJSONText + +-- | Request \'did you mean\' suggestions +data FreebaseSearchSpell + = Always + -- ^ @always@ + -- Request spelling suggestions for any query at least three characters + -- long. + | NoResults + -- ^ @no_results@ + -- Request spelling suggestions if no results were found. + | NoSpelling + -- ^ @no_spelling@ + -- Don\'t request spelling suggestions. + deriving (Eq,Ord,Enum,Read,Show,Data,Typeable,Generic) + +instance Hashable FreebaseSearchSpell + +instance FromText FreebaseSearchSpell where + fromText = \case + "always" -> Just Always + "no_results" -> Just NoResults + "no_spelling" -> Just NoSpelling + _ -> Nothing + +instance ToText FreebaseSearchSpell where + toText = \case + Always -> "always" + NoResults -> "no_results" + NoSpelling -> "no_spelling" + +instance FromJSON FreebaseSearchSpell where + parseJSON = parseJSONText "FreebaseSearchSpell" + +instance ToJSON FreebaseSearchSpell where + toJSON = toJSONText diff --git a/gen/Network/Google/Method/Freebase/Reconcile.hs b/gen/Network/Google/Method/Freebase/Reconcile.hs new file mode 100644 --- /dev/null +++ b/gen/Network/Google/Method/Freebase/Reconcile.hs @@ -0,0 +1,145 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RecordWildCards #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} + +{-# OPTIONS_GHC -fno-warn-duplicate-exports #-} +{-# OPTIONS_GHC -fno-warn-unused-binds #-} +{-# OPTIONS_GHC -fno-warn-unused-imports #-} + +-- | +-- Module : Network.Google.Method.Freebase.Reconcile +-- Copyright : (c) 2015 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +-- Reconcile entities to Freebase open data. +-- +-- /See:/ for @freebase.reconcile@. +module Network.Google.Method.Freebase.Reconcile + ( + -- * REST Resource + ReconcileMethod + + -- * Creating a Request + , reconcile + , Reconcile + + -- * Request Lenses + , rKind + , rLang + , rConfidence + , rName + , rLimit + , rProp + ) where + +import Network.Google.FreebaseSearch.Types +import Network.Google.Prelude + +-- | A resource alias for @freebase.reconcile@ method which the +-- 'Reconcile' request conforms to. +type ReconcileMethod = + "freebase" :> + "v1" :> + "reconcile" :> + QueryParams "kind" Text :> + QueryParams "lang" Text :> + QueryParam "confidence" (Textual Double) :> + QueryParam "name" Text :> + QueryParam "limit" (Textual Int32) :> + QueryParams "prop" Text :> + QueryParam "alt" AltJSON :> Get '[JSON] ReconcileGet + +-- | Reconcile entities to Freebase open data. +-- +-- /See:/ 'reconcile' smart constructor. +data Reconcile = Reconcile + { _rKind :: !(Maybe [Text]) + , _rLang :: !(Maybe [Text]) + , _rConfidence :: !(Textual Double) + , _rName :: !(Maybe Text) + , _rLimit :: !(Textual Int32) + , _rProp :: !(Maybe [Text]) + } deriving (Eq,Show,Data,Typeable,Generic) + +-- | Creates a value of 'Reconcile' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'rKind' +-- +-- * 'rLang' +-- +-- * 'rConfidence' +-- +-- * 'rName' +-- +-- * 'rLimit' +-- +-- * 'rProp' +reconcile + :: Reconcile +reconcile = + Reconcile + { _rKind = Nothing + , _rLang = Nothing + , _rConfidence = 0.99 + , _rName = Nothing + , _rLimit = 3 + , _rProp = Nothing + } + +-- | Classifications of entity e.g. type, category, title. +rKind :: Lens' Reconcile [Text] +rKind + = lens _rKind (\ s a -> s{_rKind = a}) . _Default . + _Coerce + +-- | Languages for names and values. First language is used for display. +-- Default is \'en\'. +rLang :: Lens' Reconcile [Text] +rLang + = lens _rLang (\ s a -> s{_rLang = a}) . _Default . + _Coerce + +-- | Required confidence for a candidate to match. Must be between .5 and 1.0 +rConfidence :: Lens' Reconcile Double +rConfidence + = lens _rConfidence (\ s a -> s{_rConfidence = a}) . + _Coerce + +-- | Name of entity. +rName :: Lens' Reconcile (Maybe Text) +rName = lens _rName (\ s a -> s{_rName = a}) + +-- | Maximum number of candidates to return. +rLimit :: Lens' Reconcile Int32 +rLimit + = lens _rLimit (\ s a -> s{_rLimit = a}) . _Coerce + +-- | Property values for entity formatted as : +rProp :: Lens' Reconcile [Text] +rProp + = lens _rProp (\ s a -> s{_rProp = a}) . _Default . + _Coerce + +instance GoogleRequest Reconcile where + type Rs Reconcile = ReconcileGet + requestClient Reconcile{..} + = go (_rKind ^. _Default) (_rLang ^. _Default) + (Just _rConfidence) + _rName + (Just _rLimit) + (_rProp ^. _Default) + (Just AltJSON) + freebaseSearchService + where go + = buildClient (Proxy :: Proxy ReconcileMethod) mempty diff --git a/gen/Network/Google/Method/Freebase/Search.hs b/gen/Network/Google/Method/Freebase/Search.hs new file mode 100644 --- /dev/null +++ b/gen/Network/Google/Method/Freebase/Search.hs @@ -0,0 +1,425 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RecordWildCards #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} + +{-# OPTIONS_GHC -fno-warn-duplicate-exports #-} +{-# OPTIONS_GHC -fno-warn-unused-binds #-} +{-# OPTIONS_GHC -fno-warn-unused-imports #-} + +-- | +-- Module : Network.Google.Method.Freebase.Search +-- Copyright : (c) 2015 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +-- Search Freebase open data. +-- +-- /See:/ for @freebase.search@. +module Network.Google.Method.Freebase.Search + ( + -- * REST Resource + SearchMethod + + -- * Creating a Request + , search + , Search + + -- * Request Lenses + , sWithout + , sCursor + , sWith + , sDomain + , sFormat + , sHelp + , sLang + , sIndent + , sOutput + , sQuery + , sScoring + , sLimit + , sFilter + , sMqlOutput + , sMid + , sType + , sStemmed + , sExact + , sSpell + , sAsOfTime + , sEncode + , sPrefixed + , sCallback + ) where + +import Network.Google.FreebaseSearch.Types +import Network.Google.Prelude + +-- | A resource alias for @freebase.search@ method which the +-- 'Search' request conforms to. +type SearchMethod = + "freebase" :> + "v1" :> + "search" :> + QueryParams "without" Text :> + QueryParam "cursor" (Textual Int32) :> + QueryParams "with" Text :> + QueryParams "domain" Text :> + QueryParam "format" FreebaseSearchFormat :> + QueryParam "help" FreebaseSearchHelp :> + QueryParams "lang" Text :> + QueryParam "indent" Bool :> + QueryParam "output" Text :> + QueryParam "query" Text :> + QueryParam "scoring" FreebaseSearchScoring :> + QueryParam "limit" (Textual Int32) :> + QueryParams "filter" Text :> + QueryParam "mql_output" Text :> + QueryParams "mid" Text :> + QueryParams "type" Text :> + QueryParam "stemmed" Bool :> + QueryParam "exact" Bool :> + QueryParam "spell" + FreebaseSearchSpell + :> + QueryParam "as_of_time" Text :> + QueryParam "encode" + FreebaseSearchEncode + :> + QueryParam "prefixed" Bool + :> + QueryParam "callback" + Text + :> + QueryParam "alt" + AltJSON + :> Get '[JSON] () + :<|> + "freebase" :> + "v1" :> + "search" :> + QueryParams "without" Text :> + QueryParam "cursor" (Textual Int32) :> + QueryParams "with" Text :> + QueryParams "domain" Text :> + QueryParam "format" FreebaseSearchFormat :> + QueryParam "help" FreebaseSearchHelp :> + QueryParams "lang" Text :> + QueryParam "indent" Bool :> + QueryParam "output" Text :> + QueryParam "query" Text :> + QueryParam "scoring" FreebaseSearchScoring :> + QueryParam "limit" (Textual Int32) :> + QueryParams "filter" Text :> + QueryParam "mql_output" Text :> + QueryParams "mid" Text :> + QueryParams "type" Text :> + QueryParam "stemmed" Bool :> + QueryParam "exact" Bool :> + QueryParam "spell" + FreebaseSearchSpell + :> + QueryParam "as_of_time" Text + :> + QueryParam "encode" + FreebaseSearchEncode + :> + QueryParam "prefixed" + Bool + :> + QueryParam "callback" + Text + :> + QueryParam "alt" + AltMedia + :> + Get '[OctetStream] + Stream + +-- | Search Freebase open data. +-- +-- /See:/ 'search' smart constructor. +data Search = Search + { _sWithout :: !(Maybe [Text]) + , _sCursor :: !(Maybe (Textual Int32)) + , _sWith :: !(Maybe [Text]) + , _sDomain :: !(Maybe [Text]) + , _sFormat :: !FreebaseSearchFormat + , _sHelp :: !(Maybe FreebaseSearchHelp) + , _sLang :: !(Maybe [Text]) + , _sIndent :: !(Maybe Bool) + , _sOutput :: !(Maybe Text) + , _sQuery :: !(Maybe Text) + , _sScoring :: !FreebaseSearchScoring + , _sLimit :: !(Textual Int32) + , _sFilter :: !(Maybe [Text]) + , _sMqlOutput :: !(Maybe Text) + , _sMid :: !(Maybe [Text]) + , _sType :: !(Maybe [Text]) + , _sStemmed :: !(Maybe Bool) + , _sExact :: !(Maybe Bool) + , _sSpell :: !FreebaseSearchSpell + , _sAsOfTime :: !(Maybe Text) + , _sEncode :: !FreebaseSearchEncode + , _sPrefixed :: !(Maybe Bool) + , _sCallback :: !(Maybe Text) + } deriving (Eq,Show,Data,Typeable,Generic) + +-- | Creates a value of 'Search' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'sWithout' +-- +-- * 'sCursor' +-- +-- * 'sWith' +-- +-- * 'sDomain' +-- +-- * 'sFormat' +-- +-- * 'sHelp' +-- +-- * 'sLang' +-- +-- * 'sIndent' +-- +-- * 'sOutput' +-- +-- * 'sQuery' +-- +-- * 'sScoring' +-- +-- * 'sLimit' +-- +-- * 'sFilter' +-- +-- * 'sMqlOutput' +-- +-- * 'sMid' +-- +-- * 'sType' +-- +-- * 'sStemmed' +-- +-- * 'sExact' +-- +-- * 'sSpell' +-- +-- * 'sAsOfTime' +-- +-- * 'sEncode' +-- +-- * 'sPrefixed' +-- +-- * 'sCallback' +search + :: Search +search = + Search + { _sWithout = Nothing + , _sCursor = Nothing + , _sWith = Nothing + , _sDomain = Nothing + , _sFormat = Entity + , _sHelp = Nothing + , _sLang = Nothing + , _sIndent = Nothing + , _sOutput = Nothing + , _sQuery = Nothing + , _sScoring = FSSEntity + , _sLimit = 20 + , _sFilter = Nothing + , _sMqlOutput = Nothing + , _sMid = Nothing + , _sType = Nothing + , _sStemmed = Nothing + , _sExact = Nothing + , _sSpell = NoSpelling + , _sAsOfTime = Nothing + , _sEncode = Off + , _sPrefixed = Nothing + , _sCallback = Nothing + } + +-- | A rule to not match against. +sWithout :: Lens' Search [Text] +sWithout + = lens _sWithout (\ s a -> s{_sWithout = a}) . + _Default + . _Coerce + +-- | The cursor value to use for the next page of results. +sCursor :: Lens' Search (Maybe Int32) +sCursor + = lens _sCursor (\ s a -> s{_sCursor = a}) . + mapping _Coerce + +-- | A rule to match against. +sWith :: Lens' Search [Text] +sWith + = lens _sWith (\ s a -> s{_sWith = a}) . _Default . + _Coerce + +-- | Restrict to topics with this Freebase domain id. +sDomain :: Lens' Search [Text] +sDomain + = lens _sDomain (\ s a -> s{_sDomain = a}) . _Default + . _Coerce + +-- | Structural format of the json response. +sFormat :: Lens' Search FreebaseSearchFormat +sFormat = lens _sFormat (\ s a -> s{_sFormat = a}) + +-- | The keyword to request help on. +sHelp :: Lens' Search (Maybe FreebaseSearchHelp) +sHelp = lens _sHelp (\ s a -> s{_sHelp = a}) + +-- | The code of the language to run the query with. Default is \'en\'. +sLang :: Lens' Search [Text] +sLang + = lens _sLang (\ s a -> s{_sLang = a}) . _Default . + _Coerce + +-- | Whether to indent the json results or not. +sIndent :: Lens' Search (Maybe Bool) +sIndent = lens _sIndent (\ s a -> s{_sIndent = a}) + +-- | An output expression to request data from matches. +sOutput :: Lens' Search (Maybe Text) +sOutput = lens _sOutput (\ s a -> s{_sOutput = a}) + +-- | Query term to search for. +sQuery :: Lens' Search (Maybe Text) +sQuery = lens _sQuery (\ s a -> s{_sQuery = a}) + +-- | Relevance scoring algorithm to use. +sScoring :: Lens' Search FreebaseSearchScoring +sScoring = lens _sScoring (\ s a -> s{_sScoring = a}) + +-- | Maximum number of results to return. +sLimit :: Lens' Search Int32 +sLimit + = lens _sLimit (\ s a -> s{_sLimit = a}) . _Coerce + +-- | A filter to apply to the query. +sFilter :: Lens' Search [Text] +sFilter + = lens _sFilter (\ s a -> s{_sFilter = a}) . _Default + . _Coerce + +-- | The MQL query to run againist the results to extract more data. +sMqlOutput :: Lens' Search (Maybe Text) +sMqlOutput + = lens _sMqlOutput (\ s a -> s{_sMqlOutput = a}) + +-- | A mid to use instead of a query. +sMid :: Lens' Search [Text] +sMid + = lens _sMid (\ s a -> s{_sMid = a}) . _Default . + _Coerce + +-- | Restrict to topics with this Freebase type id. +sType :: Lens' Search [Text] +sType + = lens _sType (\ s a -> s{_sType = a}) . _Default . + _Coerce + +-- | Query on stemmed names and aliases. May not be used with prefixed. +sStemmed :: Lens' Search (Maybe Bool) +sStemmed = lens _sStemmed (\ s a -> s{_sStemmed = a}) + +-- | Query on exact name and keys only. +sExact :: Lens' Search (Maybe Bool) +sExact = lens _sExact (\ s a -> s{_sExact = a}) + +-- | Request \'did you mean\' suggestions +sSpell :: Lens' Search FreebaseSearchSpell +sSpell = lens _sSpell (\ s a -> s{_sSpell = a}) + +-- | A mql as_of_time value to use with mql_output queries. +sAsOfTime :: Lens' Search (Maybe Text) +sAsOfTime + = lens _sAsOfTime (\ s a -> s{_sAsOfTime = a}) + +-- | The encoding of the response. You can use this parameter to enable html +-- encoding. +sEncode :: Lens' Search FreebaseSearchEncode +sEncode = lens _sEncode (\ s a -> s{_sEncode = a}) + +-- | Prefix match against names and aliases. +sPrefixed :: Lens' Search (Maybe Bool) +sPrefixed + = lens _sPrefixed (\ s a -> s{_sPrefixed = a}) + +-- | JS method name for JSONP callbacks. +sCallback :: Lens' Search (Maybe Text) +sCallback + = lens _sCallback (\ s a -> s{_sCallback = a}) + +instance GoogleRequest Search where + type Rs Search = () + requestClient Search{..} + = go (_sWithout ^. _Default) _sCursor + (_sWith ^. _Default) + (_sDomain ^. _Default) + (Just _sFormat) + _sHelp + (_sLang ^. _Default) + _sIndent + _sOutput + _sQuery + (Just _sScoring) + (Just _sLimit) + (_sFilter ^. _Default) + _sMqlOutput + (_sMid ^. _Default) + (_sType ^. _Default) + _sStemmed + _sExact + (Just _sSpell) + _sAsOfTime + (Just _sEncode) + _sPrefixed + _sCallback + (Just AltJSON) + freebaseSearchService + where go :<|> _ + = buildClient (Proxy :: Proxy SearchMethod) mempty + +instance GoogleRequest (MediaDownload Search) where + type Rs (MediaDownload Search) = Stream + requestClient (MediaDownload Search{..}) + = go (_sWithout ^. _Default) _sCursor + (_sWith ^. _Default) + (_sDomain ^. _Default) + (Just _sFormat) + _sHelp + (_sLang ^. _Default) + _sIndent + _sOutput + _sQuery + (Just _sScoring) + (Just _sLimit) + (_sFilter ^. _Default) + _sMqlOutput + (_sMid ^. _Default) + (_sType ^. _Default) + _sStemmed + _sExact + (Just _sSpell) + _sAsOfTime + (Just _sEncode) + _sPrefixed + _sCallback + (Just AltMedia) + freebaseSearchService + where _ :<|> go + = buildClient (Proxy :: Proxy SearchMethod) mempty diff --git a/gogol-freebasesearch.cabal b/gogol-freebasesearch.cabal new file mode 100644 --- /dev/null +++ b/gogol-freebasesearch.cabal @@ -0,0 +1,47 @@ +name: gogol-freebasesearch +version: 0.0.1 +synopsis: Google Freebase Search SDK. +homepage: https://github.com/brendanhay/gogol +bug-reports: https://github.com/brendanhay/gogol/issues +license: OtherLicense +license-file: LICENSE +author: Brendan Hay +maintainer: Brendan Hay +copyright: Copyright (c) 2015 Brendan Hay +category: Network, Google, Cloud +build-type: Simple +cabal-version: >= 1.10 +extra-source-files: README.md + +description: + Find Freebase entities using textual queries and other constraints. + . + /Warning:/ This is an experimental prototype/preview release which is still + under exploratory development and not intended for public use, caveat emptor! + . + This library is compatible with version @v1@ + of the API. + +source-repository head + type: git + location: git://github.com/brendanhay/gogol.git + +library + default-language: Haskell2010 + hs-source-dirs: src gen + + ghc-options: -Wall + + exposed-modules: + Network.Google.FreebaseSearch + , Network.Google.FreebaseSearch.Types + , Network.Google.Method.Freebase.Reconcile + , Network.Google.Method.Freebase.Search + + other-modules: + Network.Google.FreebaseSearch.Types.Product + , Network.Google.FreebaseSearch.Types.Sum + + build-depends: + gogol-core == 0.0.1.* + , base >= 4.7 && < 5