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-acceleratedmobilepageurl + +* [Version](#version) +* [Description](#description) +* [Contribute](#contribute) +* [Licence](#licence) + + +## Version + +`0.3.0` + + +## Description + +A client library for the Google Accelerated Mobile Pages (AMP) URL. + + +## Contribute + +For any problems, comments, or feedback please create an issue [here on GitHub](https://github.com/brendanhay/gogol/issues). + +> _Note:_ this library is an auto-generated Haskell package. Please see `gogol-gen` for more information. + + +## Licence + +`gogol-acceleratedmobilepageurl` 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/AcceleratedMobilePageURL.hs b/gen/Network/Google/AcceleratedMobilePageURL.hs new file mode 100644 --- /dev/null +++ b/gen/Network/Google/AcceleratedMobilePageURL.hs @@ -0,0 +1,81 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE TypeOperators #-} + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} +{-# OPTIONS_GHC -fno-warn-duplicate-exports #-} + +-- | +-- Module : Network.Google.AcceleratedMobilePageURL +-- Copyright : (c) 2015-2016 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +-- Retrieves the list of AMP URLs (and equivalent AMP Cache URLs) for a +-- given list of public URL(s). +-- +-- /See:/ +module Network.Google.AcceleratedMobilePageURL + ( + -- * Service Configuration + acceleratedMobilePageUrlService + + -- * API Declaration + , AcceleratedMobilePageUrlAPI + + -- * Resources + + -- ** acceleratedmobilepageurl.ampUrls.batchGet + , module Network.Google.Resource.AcceleratedMobilePageURL.AmpURLs.BatchGet + + -- * Types + + -- ** AmpURLError + , AmpURLError + , ampURLError + , aueOriginalURL + , aueErrorCode + , aueErrorMessage + + -- ** AmpURLErrorErrorCode + , AmpURLErrorErrorCode (..) + + -- ** BatchGetAmpURLsResponse + , BatchGetAmpURLsResponse + , batchGetAmpURLsResponse + , bgaurAmpURLs + , bgaurURLErrors + + -- ** BatchGetAmpURLsRequest + , BatchGetAmpURLsRequest + , batchGetAmpURLsRequest + , bgaurURLs + , bgaurLookupStrategy + + -- ** AmpURL + , AmpURL + , ampURL + , auOriginalURL + , auAmpURL + , auCdnAmpURL + + -- ** Xgafv + , Xgafv (..) + + -- ** BatchGetAmpURLsRequestLookupStrategy + , BatchGetAmpURLsRequestLookupStrategy (..) + ) where + +import Network.Google.AcceleratedMobilePageURL.Types +import Network.Google.Prelude +import Network.Google.Resource.AcceleratedMobilePageURL.AmpURLs.BatchGet + +{- $resources +TODO +-} + +-- | Represents the entirety of the methods and resources available for the Accelerated Mobile Pages (AMP) URL API service. +type AcceleratedMobilePageUrlAPI = + AmpURLsBatchGetResource diff --git a/gen/Network/Google/AcceleratedMobilePageURL/Types.hs b/gen/Network/Google/AcceleratedMobilePageURL/Types.hs new file mode 100644 --- /dev/null +++ b/gen/Network/Google/AcceleratedMobilePageURL/Types.hs @@ -0,0 +1,67 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE OverloadedStrings #-} + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} + +-- | +-- Module : Network.Google.AcceleratedMobilePageURL.Types +-- Copyright : (c) 2015-2016 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +module Network.Google.AcceleratedMobilePageURL.Types + ( + -- * Service Configuration + acceleratedMobilePageUrlService + + -- * AmpURLError + , AmpURLError + , ampURLError + , aueOriginalURL + , aueErrorCode + , aueErrorMessage + + -- * AmpURLErrorErrorCode + , AmpURLErrorErrorCode (..) + + -- * BatchGetAmpURLsResponse + , BatchGetAmpURLsResponse + , batchGetAmpURLsResponse + , bgaurAmpURLs + , bgaurURLErrors + + -- * BatchGetAmpURLsRequest + , BatchGetAmpURLsRequest + , batchGetAmpURLsRequest + , bgaurURLs + , bgaurLookupStrategy + + -- * AmpURL + , AmpURL + , ampURL + , auOriginalURL + , auAmpURL + , auCdnAmpURL + + -- * Xgafv + , Xgafv (..) + + -- * BatchGetAmpURLsRequestLookupStrategy + , BatchGetAmpURLsRequestLookupStrategy (..) + ) where + +import Network.Google.AcceleratedMobilePageURL.Types.Product +import Network.Google.AcceleratedMobilePageURL.Types.Sum +import Network.Google.Prelude + +-- | Default request referring to version 'v1' of the Accelerated Mobile Pages (AMP) URL API. This contains the host and root path used as a starting point for constructing service requests. +acceleratedMobilePageUrlService :: ServiceConfig +acceleratedMobilePageUrlService + = defaultService + (ServiceId "acceleratedmobilepageurl:v1") + "acceleratedmobilepageurl.googleapis.com" diff --git a/gen/Network/Google/AcceleratedMobilePageURL/Types/Product.hs b/gen/Network/Google/AcceleratedMobilePageURL/Types/Product.hs new file mode 100644 --- /dev/null +++ b/gen/Network/Google/AcceleratedMobilePageURL/Types/Product.hs @@ -0,0 +1,249 @@ +{-# 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.AcceleratedMobilePageURL.Types.Product +-- Copyright : (c) 2015-2016 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +module Network.Google.AcceleratedMobilePageURL.Types.Product where + +import Network.Google.AcceleratedMobilePageURL.Types.Sum +import Network.Google.Prelude + +-- | AMP URL Error resource for a requested URL that couldn\'t be found. +-- +-- /See:/ 'ampURLError' smart constructor. +data AmpURLError = AmpURLError' + { _aueOriginalURL :: !(Maybe Text) + , _aueErrorCode :: !(Maybe AmpURLErrorErrorCode) + , _aueErrorMessage :: !(Maybe Text) + } deriving (Eq,Show,Data,Typeable,Generic) + +-- | Creates a value of 'AmpURLError' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'aueOriginalURL' +-- +-- * 'aueErrorCode' +-- +-- * 'aueErrorMessage' +ampURLError + :: AmpURLError +ampURLError = + AmpURLError' + { _aueOriginalURL = Nothing + , _aueErrorCode = Nothing + , _aueErrorMessage = Nothing + } + +-- | The original non-AMP URL. +aueOriginalURL :: Lens' AmpURLError (Maybe Text) +aueOriginalURL + = lens _aueOriginalURL + (\ s a -> s{_aueOriginalURL = a}) + +-- | The error code of an API call. +aueErrorCode :: Lens' AmpURLError (Maybe AmpURLErrorErrorCode) +aueErrorCode + = lens _aueErrorCode (\ s a -> s{_aueErrorCode = a}) + +-- | An optional descriptive error message. +aueErrorMessage :: Lens' AmpURLError (Maybe Text) +aueErrorMessage + = lens _aueErrorMessage + (\ s a -> s{_aueErrorMessage = a}) + +instance FromJSON AmpURLError where + parseJSON + = withObject "AmpURLError" + (\ o -> + AmpURLError' <$> + (o .:? "originalUrl") <*> (o .:? "errorCode") <*> + (o .:? "errorMessage")) + +instance ToJSON AmpURLError where + toJSON AmpURLError'{..} + = object + (catMaybes + [("originalUrl" .=) <$> _aueOriginalURL, + ("errorCode" .=) <$> _aueErrorCode, + ("errorMessage" .=) <$> _aueErrorMessage]) + +-- | Batch AMP URL response. +-- +-- /See:/ 'batchGetAmpURLsResponse' smart constructor. +data BatchGetAmpURLsResponse = BatchGetAmpURLsResponse' + { _bgaurAmpURLs :: !(Maybe [AmpURL]) + , _bgaurURLErrors :: !(Maybe [AmpURLError]) + } deriving (Eq,Show,Data,Typeable,Generic) + +-- | Creates a value of 'BatchGetAmpURLsResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'bgaurAmpURLs' +-- +-- * 'bgaurURLErrors' +batchGetAmpURLsResponse + :: BatchGetAmpURLsResponse +batchGetAmpURLsResponse = + BatchGetAmpURLsResponse' + { _bgaurAmpURLs = Nothing + , _bgaurURLErrors = Nothing + } + +-- | For each URL in BatchAmpUrlsRequest, the URL response. The response +-- might not be in the same order as URLs in the batch request. If +-- BatchAmpUrlsRequest contains duplicate URLs, AmpUrl is generated only +-- once. +bgaurAmpURLs :: Lens' BatchGetAmpURLsResponse [AmpURL] +bgaurAmpURLs + = lens _bgaurAmpURLs (\ s a -> s{_bgaurAmpURLs = a}) + . _Default + . _Coerce + +-- | The errors for requested URLs that have no AMP URL. +bgaurURLErrors :: Lens' BatchGetAmpURLsResponse [AmpURLError] +bgaurURLErrors + = lens _bgaurURLErrors + (\ s a -> s{_bgaurURLErrors = a}) + . _Default + . _Coerce + +instance FromJSON BatchGetAmpURLsResponse where + parseJSON + = withObject "BatchGetAmpURLsResponse" + (\ o -> + BatchGetAmpURLsResponse' <$> + (o .:? "ampUrls" .!= mempty) <*> + (o .:? "urlErrors" .!= mempty)) + +instance ToJSON BatchGetAmpURLsResponse where + toJSON BatchGetAmpURLsResponse'{..} + = object + (catMaybes + [("ampUrls" .=) <$> _bgaurAmpURLs, + ("urlErrors" .=) <$> _bgaurURLErrors]) + +-- | AMP URL request for a batch of URLs. +-- +-- /See:/ 'batchGetAmpURLsRequest' smart constructor. +data BatchGetAmpURLsRequest = BatchGetAmpURLsRequest' + { _bgaurURLs :: !(Maybe [Text]) + , _bgaurLookupStrategy :: !(Maybe BatchGetAmpURLsRequestLookupStrategy) + } deriving (Eq,Show,Data,Typeable,Generic) + +-- | Creates a value of 'BatchGetAmpURLsRequest' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'bgaurURLs' +-- +-- * 'bgaurLookupStrategy' +batchGetAmpURLsRequest + :: BatchGetAmpURLsRequest +batchGetAmpURLsRequest = + BatchGetAmpURLsRequest' + { _bgaurURLs = Nothing + , _bgaurLookupStrategy = Nothing + } + +-- | List of URLs to look up for the paired AMP URLs. The URLs are +-- case-sensitive. Up to 50 URLs per lookup (see [Usage +-- Limits](\/amp\/cache\/reference\/limits)). +bgaurURLs :: Lens' BatchGetAmpURLsRequest [Text] +bgaurURLs + = lens _bgaurURLs (\ s a -> s{_bgaurURLs = a}) . + _Default + . _Coerce + +-- | The lookup_strategy being requested. +bgaurLookupStrategy :: Lens' BatchGetAmpURLsRequest (Maybe BatchGetAmpURLsRequestLookupStrategy) +bgaurLookupStrategy + = lens _bgaurLookupStrategy + (\ s a -> s{_bgaurLookupStrategy = a}) + +instance FromJSON BatchGetAmpURLsRequest where + parseJSON + = withObject "BatchGetAmpURLsRequest" + (\ o -> + BatchGetAmpURLsRequest' <$> + (o .:? "urls" .!= mempty) <*> + (o .:? "lookupStrategy")) + +instance ToJSON BatchGetAmpURLsRequest where + toJSON BatchGetAmpURLsRequest'{..} + = object + (catMaybes + [("urls" .=) <$> _bgaurURLs, + ("lookupStrategy" .=) <$> _bgaurLookupStrategy]) + +-- | AMP URL response for a requested URL. +-- +-- /See:/ 'ampURL' smart constructor. +data AmpURL = AmpURL' + { _auOriginalURL :: !(Maybe Text) + , _auAmpURL :: !(Maybe Text) + , _auCdnAmpURL :: !(Maybe Text) + } deriving (Eq,Show,Data,Typeable,Generic) + +-- | Creates a value of 'AmpURL' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'auOriginalURL' +-- +-- * 'auAmpURL' +-- +-- * 'auCdnAmpURL' +ampURL + :: AmpURL +ampURL = + AmpURL' + { _auOriginalURL = Nothing + , _auAmpURL = Nothing + , _auCdnAmpURL = Nothing + } + +-- | The original non-AMP URL. +auOriginalURL :: Lens' AmpURL (Maybe Text) +auOriginalURL + = lens _auOriginalURL + (\ s a -> s{_auOriginalURL = a}) + +-- | The AMP URL pointing to the publisher\'s web server. +auAmpURL :: Lens' AmpURL (Maybe Text) +auAmpURL = lens _auAmpURL (\ s a -> s{_auAmpURL = a}) + +-- | The [AMP Cache URL](\/amp\/cache\/overview#amp-cache-url-format) +-- pointing to the cached document in the Google AMP Cache. +auCdnAmpURL :: Lens' AmpURL (Maybe Text) +auCdnAmpURL + = lens _auCdnAmpURL (\ s a -> s{_auCdnAmpURL = a}) + +instance FromJSON AmpURL where + parseJSON + = withObject "AmpURL" + (\ o -> + AmpURL' <$> + (o .:? "originalUrl") <*> (o .:? "ampUrl") <*> + (o .:? "cdnAmpUrl")) + +instance ToJSON AmpURL where + toJSON AmpURL'{..} + = object + (catMaybes + [("originalUrl" .=) <$> _auOriginalURL, + ("ampUrl" .=) <$> _auAmpURL, + ("cdnAmpUrl" .=) <$> _auCdnAmpURL]) diff --git a/gen/Network/Google/AcceleratedMobilePageURL/Types/Sum.hs b/gen/Network/Google/AcceleratedMobilePageURL/Types/Sum.hs new file mode 100644 --- /dev/null +++ b/gen/Network/Google/AcceleratedMobilePageURL/Types/Sum.hs @@ -0,0 +1,140 @@ +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE LambdaCase #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE OverloadedStrings #-} + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} + +-- | +-- Module : Network.Google.AcceleratedMobilePageURL.Types.Sum +-- Copyright : (c) 2015-2016 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +module Network.Google.AcceleratedMobilePageURL.Types.Sum where + +import Network.Google.Prelude hiding (Bytes) + +-- | The error code of an API call. +data AmpURLErrorErrorCode + = ErrorCodeUnspecified + -- ^ @ERROR_CODE_UNSPECIFIED@ + -- Not specified error. + | InputURLNotFound + -- ^ @INPUT_URL_NOT_FOUND@ + -- Indicates the requested URL is not found in the index, possibly because + -- it\'s unable to be found, not able to be accessed by Googlebot, or some + -- other error. + | NoAmpURL + -- ^ @NO_AMP_URL@ + -- Indicates no AMP URL has been found that corresponds to the requested + -- URL. + | ApplicationError + -- ^ @APPLICATION_ERROR@ + -- Indicates some kind of application error occurred at the server. Client + -- advised to retry. + | URLIsValidAmp + -- ^ @URL_IS_VALID_AMP@ + -- DEPRECATED: Indicates the requested URL is a valid AMP URL. This is a + -- non-error state, should not be relied upon as a sign of success or + -- failure. It will be removed in future versions of the API. + | URLIsInvalidAmp + -- ^ @URL_IS_INVALID_AMP@ + -- Indicates that an AMP URL has been found that corresponds to the request + -- URL, but it is not valid AMP HTML. + deriving (Eq, Ord, Enum, Read, Show, Data, Typeable, Generic) + +instance Hashable AmpURLErrorErrorCode + +instance FromHttpApiData AmpURLErrorErrorCode where + parseQueryParam = \case + "ERROR_CODE_UNSPECIFIED" -> Right ErrorCodeUnspecified + "INPUT_URL_NOT_FOUND" -> Right InputURLNotFound + "NO_AMP_URL" -> Right NoAmpURL + "APPLICATION_ERROR" -> Right ApplicationError + "URL_IS_VALID_AMP" -> Right URLIsValidAmp + "URL_IS_INVALID_AMP" -> Right URLIsInvalidAmp + x -> Left ("Unable to parse AmpURLErrorErrorCode from: " <> x) + +instance ToHttpApiData AmpURLErrorErrorCode where + toQueryParam = \case + ErrorCodeUnspecified -> "ERROR_CODE_UNSPECIFIED" + InputURLNotFound -> "INPUT_URL_NOT_FOUND" + NoAmpURL -> "NO_AMP_URL" + ApplicationError -> "APPLICATION_ERROR" + URLIsValidAmp -> "URL_IS_VALID_AMP" + URLIsInvalidAmp -> "URL_IS_INVALID_AMP" + +instance FromJSON AmpURLErrorErrorCode where + parseJSON = parseJSONText "AmpURLErrorErrorCode" + +instance ToJSON AmpURLErrorErrorCode where + toJSON = toJSONText + +-- | V1 error format. +data Xgafv + = X1 + -- ^ @1@ + -- v1 error format + | X2 + -- ^ @2@ + -- v2 error format + deriving (Eq, Ord, Enum, Read, Show, Data, Typeable, Generic) + +instance Hashable Xgafv + +instance FromHttpApiData Xgafv where + parseQueryParam = \case + "1" -> Right X1 + "2" -> Right X2 + x -> Left ("Unable to parse Xgafv from: " <> x) + +instance ToHttpApiData Xgafv where + toQueryParam = \case + X1 -> "1" + X2 -> "2" + +instance FromJSON Xgafv where + parseJSON = parseJSONText "Xgafv" + +instance ToJSON Xgafv where + toJSON = toJSONText + +-- | The lookup_strategy being requested. +data BatchGetAmpURLsRequestLookupStrategy + = FetchLiveDoc + -- ^ @FETCH_LIVE_DOC@ + -- FETCH_LIVE_DOC strategy involves live document fetch of URLs not found + -- in the index. Any request URL not found in the index is crawled in + -- realtime to validate if there is a corresponding AMP URL. This strategy + -- has higher coverage but with extra latency introduced by realtime + -- crawling. This is the default strategy. Applications using this strategy + -- should set higher HTTP timeouts of the API calls. + | InIndexDoc + -- ^ @IN_INDEX_DOC@ + -- IN_INDEX_DOC strategy skips fetching live documents of URL(s) not found + -- in index. For applications which need low latency use of IN_INDEX_DOC + -- strategy is recommended. + deriving (Eq, Ord, Enum, Read, Show, Data, Typeable, Generic) + +instance Hashable BatchGetAmpURLsRequestLookupStrategy + +instance FromHttpApiData BatchGetAmpURLsRequestLookupStrategy where + parseQueryParam = \case + "FETCH_LIVE_DOC" -> Right FetchLiveDoc + "IN_INDEX_DOC" -> Right InIndexDoc + x -> Left ("Unable to parse BatchGetAmpURLsRequestLookupStrategy from: " <> x) + +instance ToHttpApiData BatchGetAmpURLsRequestLookupStrategy where + toQueryParam = \case + FetchLiveDoc -> "FETCH_LIVE_DOC" + InIndexDoc -> "IN_INDEX_DOC" + +instance FromJSON BatchGetAmpURLsRequestLookupStrategy where + parseJSON = parseJSONText "BatchGetAmpURLsRequestLookupStrategy" + +instance ToJSON BatchGetAmpURLsRequestLookupStrategy where + toJSON = toJSONText diff --git a/gen/Network/Google/Resource/AcceleratedMobilePageURL/AmpURLs/BatchGet.hs b/gen/Network/Google/Resource/AcceleratedMobilePageURL/AmpURLs/BatchGet.hs new file mode 100644 --- /dev/null +++ b/gen/Network/Google/Resource/AcceleratedMobilePageURL/AmpURLs/BatchGet.hs @@ -0,0 +1,149 @@ +{-# 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.Resource.AcceleratedMobilePageURL.AmpURLs.BatchGet +-- Copyright : (c) 2015-2016 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +-- Returns AMP URL(s) and equivalent [AMP Cache +-- URL(s)](\/amp\/cache\/overview#amp-cache-url-format). +-- +-- /See:/ for @acceleratedmobilepageurl.ampUrls.batchGet@. +module Network.Google.Resource.AcceleratedMobilePageURL.AmpURLs.BatchGet + ( + -- * REST Resource + AmpURLsBatchGetResource + + -- * Creating a Request + , ampURLsBatchGet + , AmpURLsBatchGet + + -- * Request Lenses + , aubgXgafv + , aubgUploadProtocol + , aubgAccessToken + , aubgUploadType + , aubgPayload + , aubgCallback + ) where + +import Network.Google.AcceleratedMobilePageURL.Types +import Network.Google.Prelude + +-- | A resource alias for @acceleratedmobilepageurl.ampUrls.batchGet@ method which the +-- 'AmpURLsBatchGet' request conforms to. +type AmpURLsBatchGetResource = + "v1" :> + "ampUrls:batchGet" :> + QueryParam "$.xgafv" Xgafv :> + QueryParam "upload_protocol" Text :> + QueryParam "access_token" Text :> + QueryParam "uploadType" Text :> + QueryParam "callback" Text :> + QueryParam "alt" AltJSON :> + ReqBody '[JSON] BatchGetAmpURLsRequest :> + Post '[JSON] BatchGetAmpURLsResponse + +-- | Returns AMP URL(s) and equivalent [AMP Cache +-- URL(s)](\/amp\/cache\/overview#amp-cache-url-format). +-- +-- /See:/ 'ampURLsBatchGet' smart constructor. +data AmpURLsBatchGet = AmpURLsBatchGet' + { _aubgXgafv :: !(Maybe Xgafv) + , _aubgUploadProtocol :: !(Maybe Text) + , _aubgAccessToken :: !(Maybe Text) + , _aubgUploadType :: !(Maybe Text) + , _aubgPayload :: !BatchGetAmpURLsRequest + , _aubgCallback :: !(Maybe Text) + } deriving (Eq,Show,Data,Typeable,Generic) + +-- | Creates a value of 'AmpURLsBatchGet' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'aubgXgafv' +-- +-- * 'aubgUploadProtocol' +-- +-- * 'aubgAccessToken' +-- +-- * 'aubgUploadType' +-- +-- * 'aubgPayload' +-- +-- * 'aubgCallback' +ampURLsBatchGet + :: BatchGetAmpURLsRequest -- ^ 'aubgPayload' + -> AmpURLsBatchGet +ampURLsBatchGet pAubgPayload_ = + AmpURLsBatchGet' + { _aubgXgafv = Nothing + , _aubgUploadProtocol = Nothing + , _aubgAccessToken = Nothing + , _aubgUploadType = Nothing + , _aubgPayload = pAubgPayload_ + , _aubgCallback = Nothing + } + +-- | V1 error format. +aubgXgafv :: Lens' AmpURLsBatchGet (Maybe Xgafv) +aubgXgafv + = lens _aubgXgafv (\ s a -> s{_aubgXgafv = a}) + +-- | Upload protocol for media (e.g. \"raw\", \"multipart\"). +aubgUploadProtocol :: Lens' AmpURLsBatchGet (Maybe Text) +aubgUploadProtocol + = lens _aubgUploadProtocol + (\ s a -> s{_aubgUploadProtocol = a}) + +-- | OAuth access token. +aubgAccessToken :: Lens' AmpURLsBatchGet (Maybe Text) +aubgAccessToken + = lens _aubgAccessToken + (\ s a -> s{_aubgAccessToken = a}) + +-- | Legacy upload protocol for media (e.g. \"media\", \"multipart\"). +aubgUploadType :: Lens' AmpURLsBatchGet (Maybe Text) +aubgUploadType + = lens _aubgUploadType + (\ s a -> s{_aubgUploadType = a}) + +-- | Multipart request metadata. +aubgPayload :: Lens' AmpURLsBatchGet BatchGetAmpURLsRequest +aubgPayload + = lens _aubgPayload (\ s a -> s{_aubgPayload = a}) + +-- | JSONP +aubgCallback :: Lens' AmpURLsBatchGet (Maybe Text) +aubgCallback + = lens _aubgCallback (\ s a -> s{_aubgCallback = a}) + +instance GoogleRequest AmpURLsBatchGet where + type Rs AmpURLsBatchGet = BatchGetAmpURLsResponse + type Scopes AmpURLsBatchGet = '[] + requestClient AmpURLsBatchGet'{..} + = go _aubgXgafv _aubgUploadProtocol _aubgAccessToken + _aubgUploadType + _aubgCallback + (Just AltJSON) + _aubgPayload + acceleratedMobilePageUrlService + where go + = buildClient + (Proxy :: Proxy AmpURLsBatchGetResource) + mempty diff --git a/gogol-acceleratedmobilepageurl.cabal b/gogol-acceleratedmobilepageurl.cabal new file mode 100644 --- /dev/null +++ b/gogol-acceleratedmobilepageurl.cabal @@ -0,0 +1,47 @@ +name: gogol-acceleratedmobilepageurl +version: 0.4.0 +synopsis: Google Accelerated Mobile Pages (AMP) URL 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-2016 Brendan Hay +category: Network, Google, Cloud +build-type: Simple +cabal-version: >= 1.10 +extra-source-files: README.md src/.gitkeep + +description: + Retrieves the list of AMP URLs (and equivalent AMP Cache URLs) for a + given list of public URL(s). + . + /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.AcceleratedMobilePageURL + , Network.Google.AcceleratedMobilePageURL.Types + , Network.Google.Resource.AcceleratedMobilePageURL.AmpURLs.BatchGet + + other-modules: + Network.Google.AcceleratedMobilePageURL.Types.Product + , Network.Google.AcceleratedMobilePageURL.Types.Sum + + build-depends: + gogol-core == 0.4.0.* + , base >= 4.7 && < 5 diff --git a/src/.gitkeep b/src/.gitkeep new file mode 100644 --- /dev/null +++ b/src/.gitkeep