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-digitalassetlinks + +* [Version](#version) +* [Description](#description) +* [Contribute](#contribute) +* [Licence](#licence) + + +## Version + +`0.3.0` + + +## Description + +A client library for the Google Digital Asset Links. + + +## 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-digitalassetlinks` 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/DigitalAssetLinks.hs b/gen/Network/Google/DigitalAssetLinks.hs new file mode 100644 --- /dev/null +++ b/gen/Network/Google/DigitalAssetLinks.hs @@ -0,0 +1,98 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE TypeOperators #-} + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} +{-# OPTIONS_GHC -fno-warn-duplicate-exports #-} + +-- | +-- Module : Network.Google.DigitalAssetLinks +-- Copyright : (c) 2015-2016 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +-- Discovers relationships between online assets such as websites or mobile +-- apps. +-- +-- /See:/ +module Network.Google.DigitalAssetLinks + ( + -- * Service Configuration + digitalAssetLinksService + + -- * API Declaration + , DigitalAssetLinksAPI + + -- * Resources + + -- ** digitalassetlinks.assetlinks.check + , module Network.Google.Resource.DigitalAssetLinks.Assetlinks.Check + + -- ** digitalassetlinks.statements.list + , module Network.Google.Resource.DigitalAssetLinks.Statements.List + + -- * Types + + -- ** AndroidAppAsset + , AndroidAppAsset + , androidAppAsset + , aaaPackageName + , aaaCertificate + + -- ** Statement + , Statement + , statement + , sRelation + , sSource + , sTarget + + -- ** Asset + , Asset + , asset + , aAndroidApp + , aWeb + + -- ** ListResponse + , ListResponse + , listResponse + , lrDebugString + , lrMaxAge + , lrErrorCode + , lrStatements + + -- ** Xgafv + , Xgafv (..) + + -- ** CheckResponse + , CheckResponse + , checkResponse + , crDebugString + , crMaxAge + , crErrorCode + , crLinked + + -- ** WebAsset + , WebAsset + , webAsset + , waSite + + -- ** CertificateInfo + , CertificateInfo + , certificateInfo + , ciSha256Fingerprint + ) where + +import Network.Google.DigitalAssetLinks.Types +import Network.Google.Prelude +import Network.Google.Resource.DigitalAssetLinks.Assetlinks.Check +import Network.Google.Resource.DigitalAssetLinks.Statements.List + +{- $resources +TODO +-} + +-- | Represents the entirety of the methods and resources available for the Digital Asset Links API service. +type DigitalAssetLinksAPI = + AssetlinksCheckResource :<|> StatementsListResource diff --git a/gen/Network/Google/DigitalAssetLinks/Types.hs b/gen/Network/Google/DigitalAssetLinks/Types.hs new file mode 100644 --- /dev/null +++ b/gen/Network/Google/DigitalAssetLinks/Types.hs @@ -0,0 +1,79 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE OverloadedStrings #-} + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} + +-- | +-- Module : Network.Google.DigitalAssetLinks.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.DigitalAssetLinks.Types + ( + -- * Service Configuration + digitalAssetLinksService + + -- * AndroidAppAsset + , AndroidAppAsset + , androidAppAsset + , aaaPackageName + , aaaCertificate + + -- * Statement + , Statement + , statement + , sRelation + , sSource + , sTarget + + -- * Asset + , Asset + , asset + , aAndroidApp + , aWeb + + -- * ListResponse + , ListResponse + , listResponse + , lrDebugString + , lrMaxAge + , lrErrorCode + , lrStatements + + -- * Xgafv + , Xgafv (..) + + -- * CheckResponse + , CheckResponse + , checkResponse + , crDebugString + , crMaxAge + , crErrorCode + , crLinked + + -- * WebAsset + , WebAsset + , webAsset + , waSite + + -- * CertificateInfo + , CertificateInfo + , certificateInfo + , ciSha256Fingerprint + ) where + +import Network.Google.DigitalAssetLinks.Types.Product +import Network.Google.DigitalAssetLinks.Types.Sum +import Network.Google.Prelude + +-- | Default request referring to version 'v1' of the Digital Asset Links API. This contains the host and root path used as a starting point for constructing service requests. +digitalAssetLinksService :: ServiceConfig +digitalAssetLinksService + = defaultService (ServiceId "digitalassetlinks:v1") + "digitalassetlinks.googleapis.com" diff --git a/gen/Network/Google/DigitalAssetLinks/Types/Product.hs b/gen/Network/Google/DigitalAssetLinks/Types/Product.hs new file mode 100644 --- /dev/null +++ b/gen/Network/Google/DigitalAssetLinks/Types/Product.hs @@ -0,0 +1,460 @@ +{-# 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.DigitalAssetLinks.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.DigitalAssetLinks.Types.Product where + +import Network.Google.DigitalAssetLinks.Types.Sum +import Network.Google.Prelude + +-- | Describes an android app asset. +-- +-- /See:/ 'androidAppAsset' smart constructor. +data AndroidAppAsset = AndroidAppAsset' + { _aaaPackageName :: !(Maybe Text) + , _aaaCertificate :: !(Maybe CertificateInfo) + } deriving (Eq,Show,Data,Typeable,Generic) + +-- | Creates a value of 'AndroidAppAsset' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'aaaPackageName' +-- +-- * 'aaaCertificate' +androidAppAsset + :: AndroidAppAsset +androidAppAsset = + AndroidAppAsset' + { _aaaPackageName = Nothing + , _aaaCertificate = Nothing + } + +-- | Android App assets are naturally identified by their Java package name. +-- For example, the Google Maps app uses the package name +-- \`com.google.android.apps.maps\`. REQUIRED +aaaPackageName :: Lens' AndroidAppAsset (Maybe Text) +aaaPackageName + = lens _aaaPackageName + (\ s a -> s{_aaaPackageName = a}) + +-- | Because there is no global enforcement of package name uniqueness, we +-- also require a signing certificate, which in combination with the +-- package name uniquely identifies an app. Some apps\' signing keys are +-- rotated, so they may be signed by different keys over time. We treat +-- these as distinct assets, since we use (package name, cert) as the +-- unique ID. This should not normally pose any problems as both versions +-- of the app will make the same or similar statements. Other assets making +-- statements about the app will have to be updated when a key is rotated, +-- however. (Note that the syntaxes for publishing and querying for +-- statements contain syntactic sugar to easily let you specify apps that +-- are known by multiple certificates.) REQUIRED +aaaCertificate :: Lens' AndroidAppAsset (Maybe CertificateInfo) +aaaCertificate + = lens _aaaCertificate + (\ s a -> s{_aaaCertificate = a}) + +instance FromJSON AndroidAppAsset where + parseJSON + = withObject "AndroidAppAsset" + (\ o -> + AndroidAppAsset' <$> + (o .:? "packageName") <*> (o .:? "certificate")) + +instance ToJSON AndroidAppAsset where + toJSON AndroidAppAsset'{..} + = object + (catMaybes + [("packageName" .=) <$> _aaaPackageName, + ("certificate" .=) <$> _aaaCertificate]) + +-- | Describes a reliable statement that has been made about the relationship +-- between a source asset and a target asset. Statements are always made by +-- the source asset, either directly or by delegating to a statement list +-- that is stored elsewhere. For more detailed definitions of statements +-- and assets, please refer to our [API documentation landing +-- page](\/digital-asset-links\/v1\/getting-started). +-- +-- /See:/ 'statement' smart constructor. +data Statement = Statement' + { _sRelation :: !(Maybe Text) + , _sSource :: !(Maybe Asset) + , _sTarget :: !(Maybe Asset) + } deriving (Eq,Show,Data,Typeable,Generic) + +-- | Creates a value of 'Statement' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'sRelation' +-- +-- * 'sSource' +-- +-- * 'sTarget' +statement + :: Statement +statement = + Statement' + { _sRelation = Nothing + , _sSource = Nothing + , _sTarget = Nothing + } + +-- | The relation identifies the use of the statement as intended by the +-- source asset\'s owner (that is, the person or entity who issued the +-- statement). Every complete statement has a relation. We identify +-- relations with strings of the format \`\/\`, where \`\` must be one of a +-- set of pre-defined purpose categories, and \`\` is a free-form lowercase +-- alphanumeric string that describes the specific use case of the +-- statement. Refer to [our API +-- documentation](\/digital-asset-links\/v1\/relation-strings) for the +-- current list of supported relations. Example: +-- \`delegate_permission\/common.handle_all_urls\` REQUIRED +sRelation :: Lens' Statement (Maybe Text) +sRelation + = lens _sRelation (\ s a -> s{_sRelation = a}) + +-- | Every statement has a source asset. REQUIRED +sSource :: Lens' Statement (Maybe Asset) +sSource = lens _sSource (\ s a -> s{_sSource = a}) + +-- | Every statement has a target asset. REQUIRED +sTarget :: Lens' Statement (Maybe Asset) +sTarget = lens _sTarget (\ s a -> s{_sTarget = a}) + +instance FromJSON Statement where + parseJSON + = withObject "Statement" + (\ o -> + Statement' <$> + (o .:? "relation") <*> (o .:? "source") <*> + (o .:? "target")) + +instance ToJSON Statement where + toJSON Statement'{..} + = object + (catMaybes + [("relation" .=) <$> _sRelation, + ("source" .=) <$> _sSource, + ("target" .=) <$> _sTarget]) + +-- | Uniquely identifies an asset. A digital asset is an identifiable and +-- addressable online entity that typically provides some service or +-- content. Examples of assets are websites, Android apps, Twitter feeds, +-- and Plus Pages. +-- +-- /See:/ 'asset' smart constructor. +data Asset = Asset' + { _aAndroidApp :: !(Maybe AndroidAppAsset) + , _aWeb :: !(Maybe WebAsset) + } deriving (Eq,Show,Data,Typeable,Generic) + +-- | Creates a value of 'Asset' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'aAndroidApp' +-- +-- * 'aWeb' +asset + :: Asset +asset = + Asset' + { _aAndroidApp = Nothing + , _aWeb = Nothing + } + +-- | Set if this is an Android App asset. +aAndroidApp :: Lens' Asset (Maybe AndroidAppAsset) +aAndroidApp + = lens _aAndroidApp (\ s a -> s{_aAndroidApp = a}) + +-- | Set if this is a web asset. +aWeb :: Lens' Asset (Maybe WebAsset) +aWeb = lens _aWeb (\ s a -> s{_aWeb = a}) + +instance FromJSON Asset where + parseJSON + = withObject "Asset" + (\ o -> + Asset' <$> (o .:? "androidApp") <*> (o .:? "web")) + +instance ToJSON Asset where + toJSON Asset'{..} + = object + (catMaybes + [("androidApp" .=) <$> _aAndroidApp, + ("web" .=) <$> _aWeb]) + +-- | Response message for the List call. +-- +-- /See:/ 'listResponse' smart constructor. +data ListResponse = ListResponse' + { _lrDebugString :: !(Maybe Text) + , _lrMaxAge :: !(Maybe GDuration) + , _lrErrorCode :: !(Maybe [Text]) + , _lrStatements :: !(Maybe [Statement]) + } deriving (Eq,Show,Data,Typeable,Generic) + +-- | Creates a value of 'ListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'lrDebugString' +-- +-- * 'lrMaxAge' +-- +-- * 'lrErrorCode' +-- +-- * 'lrStatements' +listResponse + :: ListResponse +listResponse = + ListResponse' + { _lrDebugString = Nothing + , _lrMaxAge = Nothing + , _lrErrorCode = Nothing + , _lrStatements = Nothing + } + +-- | Human-readable message containing information intended to help end users +-- understand, reproduce and debug the result. The message will be in +-- English and we are currently not planning to offer any translations. +-- Please note that no guarantees are made about the contents or format of +-- this string. Any aspect of it may be subject to change without notice. +-- You should not attempt to programmatically parse this data. For +-- programmatic access, use the error_code field below. +lrDebugString :: Lens' ListResponse (Maybe Text) +lrDebugString + = lens _lrDebugString + (\ s a -> s{_lrDebugString = a}) + +-- | From serving time, how much longer the response should be considered +-- valid barring further updates. REQUIRED +lrMaxAge :: Lens' ListResponse (Maybe Scientific) +lrMaxAge + = lens _lrMaxAge (\ s a -> s{_lrMaxAge = a}) . + mapping _GDuration + +-- | Error codes that describe the result of the List operation. +lrErrorCode :: Lens' ListResponse [Text] +lrErrorCode + = lens _lrErrorCode (\ s a -> s{_lrErrorCode = a}) . + _Default + . _Coerce + +-- | A list of all the matching statements that have been found. +lrStatements :: Lens' ListResponse [Statement] +lrStatements + = lens _lrStatements (\ s a -> s{_lrStatements = a}) + . _Default + . _Coerce + +instance FromJSON ListResponse where + parseJSON + = withObject "ListResponse" + (\ o -> + ListResponse' <$> + (o .:? "debugString") <*> (o .:? "maxAge") <*> + (o .:? "errorCode" .!= mempty) + <*> (o .:? "statements" .!= mempty)) + +instance ToJSON ListResponse where + toJSON ListResponse'{..} + = object + (catMaybes + [("debugString" .=) <$> _lrDebugString, + ("maxAge" .=) <$> _lrMaxAge, + ("errorCode" .=) <$> _lrErrorCode, + ("statements" .=) <$> _lrStatements]) + +-- | Response message for the CheckAssetLinks call. +-- +-- /See:/ 'checkResponse' smart constructor. +data CheckResponse = CheckResponse' + { _crDebugString :: !(Maybe Text) + , _crMaxAge :: !(Maybe GDuration) + , _crErrorCode :: !(Maybe [Text]) + , _crLinked :: !(Maybe Bool) + } deriving (Eq,Show,Data,Typeable,Generic) + +-- | Creates a value of 'CheckResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'crDebugString' +-- +-- * 'crMaxAge' +-- +-- * 'crErrorCode' +-- +-- * 'crLinked' +checkResponse + :: CheckResponse +checkResponse = + CheckResponse' + { _crDebugString = Nothing + , _crMaxAge = Nothing + , _crErrorCode = Nothing + , _crLinked = Nothing + } + +-- | Human-readable message containing information intended to help end users +-- understand, reproduce and debug the result. The message will be in +-- English and we are currently not planning to offer any translations. +-- Please note that no guarantees are made about the contents or format of +-- this string. Any aspect of it may be subject to change without notice. +-- You should not attempt to programmatically parse this data. For +-- programmatic access, use the error_code field below. +crDebugString :: Lens' CheckResponse (Maybe Text) +crDebugString + = lens _crDebugString + (\ s a -> s{_crDebugString = a}) + +-- | From serving time, how much longer the response should be considered +-- valid barring further updates. REQUIRED +crMaxAge :: Lens' CheckResponse (Maybe Scientific) +crMaxAge + = lens _crMaxAge (\ s a -> s{_crMaxAge = a}) . + mapping _GDuration + +-- | Error codes that describe the result of the Check operation. +crErrorCode :: Lens' CheckResponse [Text] +crErrorCode + = lens _crErrorCode (\ s a -> s{_crErrorCode = a}) . + _Default + . _Coerce + +-- | Set to true if the assets specified in the request are linked by the +-- relation specified in the request. +crLinked :: Lens' CheckResponse (Maybe Bool) +crLinked = lens _crLinked (\ s a -> s{_crLinked = a}) + +instance FromJSON CheckResponse where + parseJSON + = withObject "CheckResponse" + (\ o -> + CheckResponse' <$> + (o .:? "debugString") <*> (o .:? "maxAge") <*> + (o .:? "errorCode" .!= mempty) + <*> (o .:? "linked")) + +instance ToJSON CheckResponse where + toJSON CheckResponse'{..} + = object + (catMaybes + [("debugString" .=) <$> _crDebugString, + ("maxAge" .=) <$> _crMaxAge, + ("errorCode" .=) <$> _crErrorCode, + ("linked" .=) <$> _crLinked]) + +-- | Describes a web asset. +-- +-- /See:/ 'webAsset' smart constructor. +newtype WebAsset = WebAsset' + { _waSite :: Maybe Text + } deriving (Eq,Show,Data,Typeable,Generic) + +-- | Creates a value of 'WebAsset' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'waSite' +webAsset + :: WebAsset +webAsset = + WebAsset' + { _waSite = Nothing + } + +-- | Web assets are identified by a URL that contains only the scheme, +-- hostname and port parts. The format is http[s]:\/\/[:] Hostnames must be +-- fully qualified: they must end in a single period (\"\`.\`\"). Only the +-- schemes \"http\" and \"https\" are currently allowed. Port numbers are +-- given as a decimal number, and they must be omitted if the standard port +-- numbers are used: 80 for http and 443 for https. We call this limited +-- URL the \"site\". All URLs that share the same scheme, hostname and port +-- are considered to be a part of the site and thus belong to the web +-- asset. Example: the asset with the site \`https:\/\/www.google.com\` +-- contains all these URLs: * \`https:\/\/www.google.com\/\` * +-- \`https:\/\/www.google.com:443\/\` * \`https:\/\/www.google.com\/foo\` * +-- \`https:\/\/www.google.com\/foo?bar\` * +-- \`https:\/\/www.google.com\/foo#bar\` * +-- \`https:\/\/user\'password:www.google.com\/\` But it does not contain +-- these URLs: * \`http:\/\/www.google.com\/\` (wrong scheme) * +-- \`https:\/\/google.com\/\` (hostname does not match) * +-- \`https:\/\/www.google.com:444\/\` (port does not match) REQUIRED +waSite :: Lens' WebAsset (Maybe Text) +waSite = lens _waSite (\ s a -> s{_waSite = a}) + +instance FromJSON WebAsset where + parseJSON + = withObject "WebAsset" + (\ o -> WebAsset' <$> (o .:? "site")) + +instance ToJSON WebAsset where + toJSON WebAsset'{..} + = object (catMaybes [("site" .=) <$> _waSite]) + +-- | Describes an X509 certificate. +-- +-- /See:/ 'certificateInfo' smart constructor. +newtype CertificateInfo = CertificateInfo' + { _ciSha256Fingerprint :: Maybe Text + } deriving (Eq,Show,Data,Typeable,Generic) + +-- | Creates a value of 'CertificateInfo' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ciSha256Fingerprint' +certificateInfo + :: CertificateInfo +certificateInfo = + CertificateInfo' + { _ciSha256Fingerprint = Nothing + } + +-- | The uppercase SHA-265 fingerprint of the certificate. From the PEM +-- certificate, it can be acquired like this: $ keytool -printcert -file +-- $CERTFILE | grep SHA256: SHA256: +-- 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \\ +-- 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 or like this: $ openssl x509 -in +-- $CERTFILE -noout -fingerprint -sha256 SHA256 +-- Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \\ +-- 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 In this example, the +-- contents of this field would be \`14:6D:E9:83:C5:73: +-- 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: +-- 44:E5\`. If these tools are not available to you, you can convert the +-- PEM certificate into the DER format, compute the SHA-256 hash of that +-- string and represent the result as a hexstring (that is, uppercase +-- hexadecimal representations of each octet, separated by colons). +ciSha256Fingerprint :: Lens' CertificateInfo (Maybe Text) +ciSha256Fingerprint + = lens _ciSha256Fingerprint + (\ s a -> s{_ciSha256Fingerprint = a}) + +instance FromJSON CertificateInfo where + parseJSON + = withObject "CertificateInfo" + (\ o -> + CertificateInfo' <$> (o .:? "sha256Fingerprint")) + +instance ToJSON CertificateInfo where + toJSON CertificateInfo'{..} + = object + (catMaybes + [("sha256Fingerprint" .=) <$> _ciSha256Fingerprint]) diff --git a/gen/Network/Google/DigitalAssetLinks/Types/Sum.hs b/gen/Network/Google/DigitalAssetLinks/Types/Sum.hs new file mode 100644 --- /dev/null +++ b/gen/Network/Google/DigitalAssetLinks/Types/Sum.hs @@ -0,0 +1,48 @@ +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE LambdaCase #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE OverloadedStrings #-} + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} + +-- | +-- Module : Network.Google.DigitalAssetLinks.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.DigitalAssetLinks.Types.Sum where + +import Network.Google.Prelude hiding (Bytes) + +-- | 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 diff --git a/gen/Network/Google/Resource/DigitalAssetLinks/Assetlinks/Check.hs b/gen/Network/Google/Resource/DigitalAssetLinks/Assetlinks/Check.hs new file mode 100644 --- /dev/null +++ b/gen/Network/Google/Resource/DigitalAssetLinks/Assetlinks/Check.hs @@ -0,0 +1,343 @@ +{-# 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.DigitalAssetLinks.Assetlinks.Check +-- Copyright : (c) 2015-2016 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +-- Determines whether the specified (directional) relationship exists +-- between the specified source and target assets. The relation describes +-- the intent of the link between the two assets as claimed by the source +-- asset. An example for such relationships is the delegation of privileges +-- or permissions. This command is most often used by infrastructure +-- systems to check preconditions for an action. For example, a client may +-- want to know if it is OK to send a web URL to a particular mobile app +-- instead. The client can check for the relevant asset link from the +-- website to the mobile app to decide if the operation should be allowed. +-- A note about security: if you specify a secure asset as the source, such +-- as an HTTPS website or an Android app, the API will ensure that any +-- statements used to generate the response have been made in a secure way +-- by the owner of that asset. Conversely, if the source asset is an +-- insecure HTTP website (that is, the URL starts with \`http:\/\/\` +-- instead of \`https:\/\/\`), the API cannot verify its statements +-- securely, and it is not possible to ensure that the website\'s +-- statements have not been altered by a third party. For more information, +-- see the [Digital Asset Links technical design +-- specification](https:\/\/github.com\/google\/digitalassetlinks\/blob\/master\/well-known\/details.md). +-- +-- /See:/ for @digitalassetlinks.assetlinks.check@. +module Network.Google.Resource.DigitalAssetLinks.Assetlinks.Check + ( + -- * REST Resource + AssetlinksCheckResource + + -- * Creating a Request + , assetlinksCheck + , AssetlinksCheck + + -- * Request Lenses + , acXgafv + , acSourceAndroidAppCertificateSha256Fingerprint + , acSourceAndroidAppPackageName + , acTargetWebSite + , acUploadProtocol + , acAccessToken + , acTargetAndroidAppCertificateSha256Fingerprint + , acUploadType + , acRelation + , acTargetAndroidAppPackageName + , acSourceWebSite + , acCallback + ) where + +import Network.Google.DigitalAssetLinks.Types +import Network.Google.Prelude + +-- | A resource alias for @digitalassetlinks.assetlinks.check@ method which the +-- 'AssetlinksCheck' request conforms to. +type AssetlinksCheckResource = + "v1" :> + "assetlinks:check" :> + QueryParam "$.xgafv" Xgafv :> + QueryParam + "source.androidApp.certificate.sha256Fingerprint" + Text + :> + QueryParam "source.androidApp.packageName" Text :> + QueryParam "target.web.site" Text :> + QueryParam "upload_protocol" Text :> + QueryParam "access_token" Text :> + QueryParam + "target.androidApp.certificate.sha256Fingerprint" + Text + :> + QueryParam "uploadType" Text :> + QueryParam "relation" Text :> + QueryParam "target.androidApp.packageName" Text :> + QueryParam "source.web.site" Text :> + QueryParam "callback" Text :> + QueryParam "alt" AltJSON :> + Get '[JSON] CheckResponse + +-- | Determines whether the specified (directional) relationship exists +-- between the specified source and target assets. The relation describes +-- the intent of the link between the two assets as claimed by the source +-- asset. An example for such relationships is the delegation of privileges +-- or permissions. This command is most often used by infrastructure +-- systems to check preconditions for an action. For example, a client may +-- want to know if it is OK to send a web URL to a particular mobile app +-- instead. The client can check for the relevant asset link from the +-- website to the mobile app to decide if the operation should be allowed. +-- A note about security: if you specify a secure asset as the source, such +-- as an HTTPS website or an Android app, the API will ensure that any +-- statements used to generate the response have been made in a secure way +-- by the owner of that asset. Conversely, if the source asset is an +-- insecure HTTP website (that is, the URL starts with \`http:\/\/\` +-- instead of \`https:\/\/\`), the API cannot verify its statements +-- securely, and it is not possible to ensure that the website\'s +-- statements have not been altered by a third party. For more information, +-- see the [Digital Asset Links technical design +-- specification](https:\/\/github.com\/google\/digitalassetlinks\/blob\/master\/well-known\/details.md). +-- +-- /See:/ 'assetlinksCheck' smart constructor. +data AssetlinksCheck = AssetlinksCheck' + { _acXgafv :: !(Maybe Xgafv) + , _acSourceAndroidAppCertificateSha256Fingerprint :: !(Maybe Text) + , _acSourceAndroidAppPackageName :: !(Maybe Text) + , _acTargetWebSite :: !(Maybe Text) + , _acUploadProtocol :: !(Maybe Text) + , _acAccessToken :: !(Maybe Text) + , _acTargetAndroidAppCertificateSha256Fingerprint :: !(Maybe Text) + , _acUploadType :: !(Maybe Text) + , _acRelation :: !(Maybe Text) + , _acTargetAndroidAppPackageName :: !(Maybe Text) + , _acSourceWebSite :: !(Maybe Text) + , _acCallback :: !(Maybe Text) + } deriving (Eq,Show,Data,Typeable,Generic) + +-- | Creates a value of 'AssetlinksCheck' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'acXgafv' +-- +-- * 'acSourceAndroidAppCertificateSha256Fingerprint' +-- +-- * 'acSourceAndroidAppPackageName' +-- +-- * 'acTargetWebSite' +-- +-- * 'acUploadProtocol' +-- +-- * 'acAccessToken' +-- +-- * 'acTargetAndroidAppCertificateSha256Fingerprint' +-- +-- * 'acUploadType' +-- +-- * 'acRelation' +-- +-- * 'acTargetAndroidAppPackageName' +-- +-- * 'acSourceWebSite' +-- +-- * 'acCallback' +assetlinksCheck + :: AssetlinksCheck +assetlinksCheck = + AssetlinksCheck' + { _acXgafv = Nothing + , _acSourceAndroidAppCertificateSha256Fingerprint = Nothing + , _acSourceAndroidAppPackageName = Nothing + , _acTargetWebSite = Nothing + , _acUploadProtocol = Nothing + , _acAccessToken = Nothing + , _acTargetAndroidAppCertificateSha256Fingerprint = Nothing + , _acUploadType = Nothing + , _acRelation = Nothing + , _acTargetAndroidAppPackageName = Nothing + , _acSourceWebSite = Nothing + , _acCallback = Nothing + } + +-- | V1 error format. +acXgafv :: Lens' AssetlinksCheck (Maybe Xgafv) +acXgafv = lens _acXgafv (\ s a -> s{_acXgafv = a}) + +-- | The uppercase SHA-265 fingerprint of the certificate. From the PEM +-- certificate, it can be acquired like this: $ keytool -printcert -file +-- $CERTFILE | grep SHA256: SHA256: +-- 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \\ +-- 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 or like this: $ openssl x509 -in +-- $CERTFILE -noout -fingerprint -sha256 SHA256 +-- Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \\ +-- 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 In this example, the +-- contents of this field would be \`14:6D:E9:83:C5:73: +-- 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: +-- 44:E5\`. If these tools are not available to you, you can convert the +-- PEM certificate into the DER format, compute the SHA-256 hash of that +-- string and represent the result as a hexstring (that is, uppercase +-- hexadecimal representations of each octet, separated by colons). +acSourceAndroidAppCertificateSha256Fingerprint :: Lens' AssetlinksCheck (Maybe Text) +acSourceAndroidAppCertificateSha256Fingerprint + = lens + _acSourceAndroidAppCertificateSha256Fingerprint + (\ s a -> + s{_acSourceAndroidAppCertificateSha256Fingerprint = + a}) + +-- | Android App assets are naturally identified by their Java package name. +-- For example, the Google Maps app uses the package name +-- \`com.google.android.apps.maps\`. REQUIRED +acSourceAndroidAppPackageName :: Lens' AssetlinksCheck (Maybe Text) +acSourceAndroidAppPackageName + = lens _acSourceAndroidAppPackageName + (\ s a -> s{_acSourceAndroidAppPackageName = a}) + +-- | Web assets are identified by a URL that contains only the scheme, +-- hostname and port parts. The format is http[s]:\/\/[:] Hostnames must be +-- fully qualified: they must end in a single period (\"\`.\`\"). Only the +-- schemes \"http\" and \"https\" are currently allowed. Port numbers are +-- given as a decimal number, and they must be omitted if the standard port +-- numbers are used: 80 for http and 443 for https. We call this limited +-- URL the \"site\". All URLs that share the same scheme, hostname and port +-- are considered to be a part of the site and thus belong to the web +-- asset. Example: the asset with the site \`https:\/\/www.google.com\` +-- contains all these URLs: * \`https:\/\/www.google.com\/\` * +-- \`https:\/\/www.google.com:443\/\` * \`https:\/\/www.google.com\/foo\` * +-- \`https:\/\/www.google.com\/foo?bar\` * +-- \`https:\/\/www.google.com\/foo#bar\` * +-- \`https:\/\/user\'password:www.google.com\/\` But it does not contain +-- these URLs: * \`http:\/\/www.google.com\/\` (wrong scheme) * +-- \`https:\/\/google.com\/\` (hostname does not match) * +-- \`https:\/\/www.google.com:444\/\` (port does not match) REQUIRED +acTargetWebSite :: Lens' AssetlinksCheck (Maybe Text) +acTargetWebSite + = lens _acTargetWebSite + (\ s a -> s{_acTargetWebSite = a}) + +-- | Upload protocol for media (e.g. \"raw\", \"multipart\"). +acUploadProtocol :: Lens' AssetlinksCheck (Maybe Text) +acUploadProtocol + = lens _acUploadProtocol + (\ s a -> s{_acUploadProtocol = a}) + +-- | OAuth access token. +acAccessToken :: Lens' AssetlinksCheck (Maybe Text) +acAccessToken + = lens _acAccessToken + (\ s a -> s{_acAccessToken = a}) + +-- | The uppercase SHA-265 fingerprint of the certificate. From the PEM +-- certificate, it can be acquired like this: $ keytool -printcert -file +-- $CERTFILE | grep SHA256: SHA256: +-- 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \\ +-- 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 or like this: $ openssl x509 -in +-- $CERTFILE -noout -fingerprint -sha256 SHA256 +-- Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \\ +-- 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 In this example, the +-- contents of this field would be \`14:6D:E9:83:C5:73: +-- 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: +-- 44:E5\`. If these tools are not available to you, you can convert the +-- PEM certificate into the DER format, compute the SHA-256 hash of that +-- string and represent the result as a hexstring (that is, uppercase +-- hexadecimal representations of each octet, separated by colons). +acTargetAndroidAppCertificateSha256Fingerprint :: Lens' AssetlinksCheck (Maybe Text) +acTargetAndroidAppCertificateSha256Fingerprint + = lens + _acTargetAndroidAppCertificateSha256Fingerprint + (\ s a -> + s{_acTargetAndroidAppCertificateSha256Fingerprint = + a}) + +-- | Legacy upload protocol for media (e.g. \"media\", \"multipart\"). +acUploadType :: Lens' AssetlinksCheck (Maybe Text) +acUploadType + = lens _acUploadType (\ s a -> s{_acUploadType = a}) + +-- | Query string for the relation. We identify relations with strings of the +-- format \`\/\`, where \`\` must be one of a set of pre-defined purpose +-- categories, and \`\` is a free-form lowercase alphanumeric string that +-- describes the specific use case of the statement. Refer to [our API +-- documentation](\/digital-asset-links\/v1\/relation-strings) for the +-- current list of supported relations. For a query to match an asset link, +-- both the query\'s and the asset link\'s relation strings must match +-- exactly. Example: A query with relation +-- \`delegate_permission\/common.handle_all_urls\` matches an asset link +-- with relation \`delegate_permission\/common.handle_all_urls\`. +acRelation :: Lens' AssetlinksCheck (Maybe Text) +acRelation + = lens _acRelation (\ s a -> s{_acRelation = a}) + +-- | Android App assets are naturally identified by their Java package name. +-- For example, the Google Maps app uses the package name +-- \`com.google.android.apps.maps\`. REQUIRED +acTargetAndroidAppPackageName :: Lens' AssetlinksCheck (Maybe Text) +acTargetAndroidAppPackageName + = lens _acTargetAndroidAppPackageName + (\ s a -> s{_acTargetAndroidAppPackageName = a}) + +-- | Web assets are identified by a URL that contains only the scheme, +-- hostname and port parts. The format is http[s]:\/\/[:] Hostnames must be +-- fully qualified: they must end in a single period (\"\`.\`\"). Only the +-- schemes \"http\" and \"https\" are currently allowed. Port numbers are +-- given as a decimal number, and they must be omitted if the standard port +-- numbers are used: 80 for http and 443 for https. We call this limited +-- URL the \"site\". All URLs that share the same scheme, hostname and port +-- are considered to be a part of the site and thus belong to the web +-- asset. Example: the asset with the site \`https:\/\/www.google.com\` +-- contains all these URLs: * \`https:\/\/www.google.com\/\` * +-- \`https:\/\/www.google.com:443\/\` * \`https:\/\/www.google.com\/foo\` * +-- \`https:\/\/www.google.com\/foo?bar\` * +-- \`https:\/\/www.google.com\/foo#bar\` * +-- \`https:\/\/user\'password:www.google.com\/\` But it does not contain +-- these URLs: * \`http:\/\/www.google.com\/\` (wrong scheme) * +-- \`https:\/\/google.com\/\` (hostname does not match) * +-- \`https:\/\/www.google.com:444\/\` (port does not match) REQUIRED +acSourceWebSite :: Lens' AssetlinksCheck (Maybe Text) +acSourceWebSite + = lens _acSourceWebSite + (\ s a -> s{_acSourceWebSite = a}) + +-- | JSONP +acCallback :: Lens' AssetlinksCheck (Maybe Text) +acCallback + = lens _acCallback (\ s a -> s{_acCallback = a}) + +instance GoogleRequest AssetlinksCheck where + type Rs AssetlinksCheck = CheckResponse + type Scopes AssetlinksCheck = '[] + requestClient AssetlinksCheck'{..} + = go _acXgafv + _acSourceAndroidAppCertificateSha256Fingerprint + _acSourceAndroidAppPackageName + _acTargetWebSite + _acUploadProtocol + _acAccessToken + _acTargetAndroidAppCertificateSha256Fingerprint + _acUploadType + _acRelation + _acTargetAndroidAppPackageName + _acSourceWebSite + _acCallback + (Just AltJSON) + digitalAssetLinksService + where go + = buildClient + (Proxy :: Proxy AssetlinksCheckResource) + mempty diff --git a/gen/Network/Google/Resource/DigitalAssetLinks/Statements/List.hs b/gen/Network/Google/Resource/DigitalAssetLinks/Statements/List.hs new file mode 100644 --- /dev/null +++ b/gen/Network/Google/Resource/DigitalAssetLinks/Statements/List.hs @@ -0,0 +1,253 @@ +{-# 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.DigitalAssetLinks.Statements.List +-- 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 a list of all statements from a given source that match the +-- specified target and statement string. The API guarantees that all +-- statements with secure source assets, such as HTTPS websites or Android +-- apps, have been made in a secure way by the owner of those assets, as +-- described in the [Digital Asset Links technical design +-- specification](https:\/\/github.com\/google\/digitalassetlinks\/blob\/master\/well-known\/details.md). +-- Specifically, you should consider that for insecure websites (that is, +-- where the URL starts with \`http:\/\/\` instead of \`https:\/\/\`), this +-- guarantee cannot be made. The \`List\` command is most useful in cases +-- where the API client wants to know all the ways in which two assets are +-- related, or enumerate all the relationships from a particular source +-- asset. Example: a feature that helps users navigate to related items. +-- When a mobile app is running on a device, the feature would make it easy +-- to navigate to the corresponding web site or Google+ profile. +-- +-- /See:/ for @digitalassetlinks.statements.list@. +module Network.Google.Resource.DigitalAssetLinks.Statements.List + ( + -- * REST Resource + StatementsListResource + + -- * Creating a Request + , statementsList + , StatementsList + + -- * Request Lenses + , slXgafv + , slSourceAndroidAppCertificateSha256Fingerprint + , slSourceAndroidAppPackageName + , slUploadProtocol + , slAccessToken + , slUploadType + , slRelation + , slSourceWebSite + , slCallback + ) where + +import Network.Google.DigitalAssetLinks.Types +import Network.Google.Prelude + +-- | A resource alias for @digitalassetlinks.statements.list@ method which the +-- 'StatementsList' request conforms to. +type StatementsListResource = + "v1" :> + "statements:list" :> + QueryParam "$.xgafv" Xgafv :> + QueryParam + "source.androidApp.certificate.sha256Fingerprint" + Text + :> + QueryParam "source.androidApp.packageName" Text :> + QueryParam "upload_protocol" Text :> + QueryParam "access_token" Text :> + QueryParam "uploadType" Text :> + QueryParam "relation" Text :> + QueryParam "source.web.site" Text :> + QueryParam "callback" Text :> + QueryParam "alt" AltJSON :> Get '[JSON] ListResponse + +-- | Retrieves a list of all statements from a given source that match the +-- specified target and statement string. The API guarantees that all +-- statements with secure source assets, such as HTTPS websites or Android +-- apps, have been made in a secure way by the owner of those assets, as +-- described in the [Digital Asset Links technical design +-- specification](https:\/\/github.com\/google\/digitalassetlinks\/blob\/master\/well-known\/details.md). +-- Specifically, you should consider that for insecure websites (that is, +-- where the URL starts with \`http:\/\/\` instead of \`https:\/\/\`), this +-- guarantee cannot be made. The \`List\` command is most useful in cases +-- where the API client wants to know all the ways in which two assets are +-- related, or enumerate all the relationships from a particular source +-- asset. Example: a feature that helps users navigate to related items. +-- When a mobile app is running on a device, the feature would make it easy +-- to navigate to the corresponding web site or Google+ profile. +-- +-- /See:/ 'statementsList' smart constructor. +data StatementsList = StatementsList' + { _slXgafv :: !(Maybe Xgafv) + , _slSourceAndroidAppCertificateSha256Fingerprint :: !(Maybe Text) + , _slSourceAndroidAppPackageName :: !(Maybe Text) + , _slUploadProtocol :: !(Maybe Text) + , _slAccessToken :: !(Maybe Text) + , _slUploadType :: !(Maybe Text) + , _slRelation :: !(Maybe Text) + , _slSourceWebSite :: !(Maybe Text) + , _slCallback :: !(Maybe Text) + } deriving (Eq,Show,Data,Typeable,Generic) + +-- | Creates a value of 'StatementsList' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'slXgafv' +-- +-- * 'slSourceAndroidAppCertificateSha256Fingerprint' +-- +-- * 'slSourceAndroidAppPackageName' +-- +-- * 'slUploadProtocol' +-- +-- * 'slAccessToken' +-- +-- * 'slUploadType' +-- +-- * 'slRelation' +-- +-- * 'slSourceWebSite' +-- +-- * 'slCallback' +statementsList + :: StatementsList +statementsList = + StatementsList' + { _slXgafv = Nothing + , _slSourceAndroidAppCertificateSha256Fingerprint = Nothing + , _slSourceAndroidAppPackageName = Nothing + , _slUploadProtocol = Nothing + , _slAccessToken = Nothing + , _slUploadType = Nothing + , _slRelation = Nothing + , _slSourceWebSite = Nothing + , _slCallback = Nothing + } + +-- | V1 error format. +slXgafv :: Lens' StatementsList (Maybe Xgafv) +slXgafv = lens _slXgafv (\ s a -> s{_slXgafv = a}) + +-- | The uppercase SHA-265 fingerprint of the certificate. From the PEM +-- certificate, it can be acquired like this: $ keytool -printcert -file +-- $CERTFILE | grep SHA256: SHA256: +-- 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \\ +-- 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 or like this: $ openssl x509 -in +-- $CERTFILE -noout -fingerprint -sha256 SHA256 +-- Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \\ +-- 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 In this example, the +-- contents of this field would be \`14:6D:E9:83:C5:73: +-- 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: +-- 44:E5\`. If these tools are not available to you, you can convert the +-- PEM certificate into the DER format, compute the SHA-256 hash of that +-- string and represent the result as a hexstring (that is, uppercase +-- hexadecimal representations of each octet, separated by colons). +slSourceAndroidAppCertificateSha256Fingerprint :: Lens' StatementsList (Maybe Text) +slSourceAndroidAppCertificateSha256Fingerprint + = lens + _slSourceAndroidAppCertificateSha256Fingerprint + (\ s a -> + s{_slSourceAndroidAppCertificateSha256Fingerprint = + a}) + +-- | Android App assets are naturally identified by their Java package name. +-- For example, the Google Maps app uses the package name +-- \`com.google.android.apps.maps\`. REQUIRED +slSourceAndroidAppPackageName :: Lens' StatementsList (Maybe Text) +slSourceAndroidAppPackageName + = lens _slSourceAndroidAppPackageName + (\ s a -> s{_slSourceAndroidAppPackageName = a}) + +-- | Upload protocol for media (e.g. \"raw\", \"multipart\"). +slUploadProtocol :: Lens' StatementsList (Maybe Text) +slUploadProtocol + = lens _slUploadProtocol + (\ s a -> s{_slUploadProtocol = a}) + +-- | OAuth access token. +slAccessToken :: Lens' StatementsList (Maybe Text) +slAccessToken + = lens _slAccessToken + (\ s a -> s{_slAccessToken = a}) + +-- | Legacy upload protocol for media (e.g. \"media\", \"multipart\"). +slUploadType :: Lens' StatementsList (Maybe Text) +slUploadType + = lens _slUploadType (\ s a -> s{_slUploadType = a}) + +-- | Use only associations that match the specified relation. See the +-- [\`Statement\`](#Statement) message for a detailed definition of +-- relation strings. For a query to match a statement, one of the following +-- must be true: * both the query\'s and the statement\'s relation strings +-- match exactly, or * the query\'s relation string is empty or missing. +-- Example: A query with relation +-- \`delegate_permission\/common.handle_all_urls\` matches an asset link +-- with relation \`delegate_permission\/common.handle_all_urls\`. +slRelation :: Lens' StatementsList (Maybe Text) +slRelation + = lens _slRelation (\ s a -> s{_slRelation = a}) + +-- | Web assets are identified by a URL that contains only the scheme, +-- hostname and port parts. The format is http[s]:\/\/[:] Hostnames must be +-- fully qualified: they must end in a single period (\"\`.\`\"). Only the +-- schemes \"http\" and \"https\" are currently allowed. Port numbers are +-- given as a decimal number, and they must be omitted if the standard port +-- numbers are used: 80 for http and 443 for https. We call this limited +-- URL the \"site\". All URLs that share the same scheme, hostname and port +-- are considered to be a part of the site and thus belong to the web +-- asset. Example: the asset with the site \`https:\/\/www.google.com\` +-- contains all these URLs: * \`https:\/\/www.google.com\/\` * +-- \`https:\/\/www.google.com:443\/\` * \`https:\/\/www.google.com\/foo\` * +-- \`https:\/\/www.google.com\/foo?bar\` * +-- \`https:\/\/www.google.com\/foo#bar\` * +-- \`https:\/\/user\'password:www.google.com\/\` But it does not contain +-- these URLs: * \`http:\/\/www.google.com\/\` (wrong scheme) * +-- \`https:\/\/google.com\/\` (hostname does not match) * +-- \`https:\/\/www.google.com:444\/\` (port does not match) REQUIRED +slSourceWebSite :: Lens' StatementsList (Maybe Text) +slSourceWebSite + = lens _slSourceWebSite + (\ s a -> s{_slSourceWebSite = a}) + +-- | JSONP +slCallback :: Lens' StatementsList (Maybe Text) +slCallback + = lens _slCallback (\ s a -> s{_slCallback = a}) + +instance GoogleRequest StatementsList where + type Rs StatementsList = ListResponse + type Scopes StatementsList = '[] + requestClient StatementsList'{..} + = go _slXgafv + _slSourceAndroidAppCertificateSha256Fingerprint + _slSourceAndroidAppPackageName + _slUploadProtocol + _slAccessToken + _slUploadType + _slRelation + _slSourceWebSite + _slCallback + (Just AltJSON) + digitalAssetLinksService + where go + = buildClient (Proxy :: Proxy StatementsListResource) + mempty diff --git a/gogol-digitalassetlinks.cabal b/gogol-digitalassetlinks.cabal new file mode 100644 --- /dev/null +++ b/gogol-digitalassetlinks.cabal @@ -0,0 +1,48 @@ +name: gogol-digitalassetlinks +version: 0.4.0 +synopsis: Google Digital Asset Links 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: + Discovers relationships between online assets such as websites or mobile + apps. + . + /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.DigitalAssetLinks + , Network.Google.DigitalAssetLinks.Types + , Network.Google.Resource.DigitalAssetLinks.Assetlinks.Check + , Network.Google.Resource.DigitalAssetLinks.Statements.List + + other-modules: + Network.Google.DigitalAssetLinks.Types.Product + , Network.Google.DigitalAssetLinks.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