{-# 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.YouTube.Subscriptions.List -- Copyright : (c) 2015 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Returns subscription resources that match the API request criteria. -- -- /See:/ for @youtube.subscriptions.list@. module Network.Google.Resource.YouTube.Subscriptions.List ( -- * REST Resource SubscriptionsListResource -- * Creating a Request , subscriptionsList , SubscriptionsList -- * Request Lenses , sPart , sMine , sChannelId , sOnBehalfOfContentOwner , sOnBehalfOfContentOwnerChannel , sId , sMySubscribers , sForChannelId , sPageToken , sOrder , sMaxResults ) where import Network.Google.Prelude import Network.Google.YouTube.Types -- | A resource alias for @youtube.subscriptions.list@ method which the -- 'SubscriptionsList' request conforms to. type SubscriptionsListResource = "youtube" :> "v3" :> "subscriptions" :> QueryParam "part" Text :> QueryParam "mine" Bool :> QueryParam "channelId" Text :> QueryParam "onBehalfOfContentOwner" Text :> QueryParam "onBehalfOfContentOwnerChannel" Text :> QueryParam "id" Text :> QueryParam "mySubscribers" Bool :> QueryParam "forChannelId" Text :> QueryParam "pageToken" Text :> QueryParam "order" SubscriptionsListOrder :> QueryParam "maxResults" (Textual Word32) :> QueryParam "alt" AltJSON :> Get '[JSON] SubscriptionListResponse -- | Returns subscription resources that match the API request criteria. -- -- /See:/ 'subscriptionsList' smart constructor. data SubscriptionsList = SubscriptionsList { _sPart :: !Text , _sMine :: !(Maybe Bool) , _sChannelId :: !(Maybe Text) , _sOnBehalfOfContentOwner :: !(Maybe Text) , _sOnBehalfOfContentOwnerChannel :: !(Maybe Text) , _sId :: !(Maybe Text) , _sMySubscribers :: !(Maybe Bool) , _sForChannelId :: !(Maybe Text) , _sPageToken :: !(Maybe Text) , _sOrder :: !SubscriptionsListOrder , _sMaxResults :: !(Textual Word32) } deriving (Eq,Show,Data,Typeable,Generic) -- | Creates a value of 'SubscriptionsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- * 'sPart' -- -- * 'sMine' -- -- * 'sChannelId' -- -- * 'sOnBehalfOfContentOwner' -- -- * 'sOnBehalfOfContentOwnerChannel' -- -- * 'sId' -- -- * 'sMySubscribers' -- -- * 'sForChannelId' -- -- * 'sPageToken' -- -- * 'sOrder' -- -- * 'sMaxResults' subscriptionsList :: Text -- ^ 'sPart' -> SubscriptionsList subscriptionsList pSPart_ = SubscriptionsList { _sPart = pSPart_ , _sMine = Nothing , _sChannelId = Nothing , _sOnBehalfOfContentOwner = Nothing , _sOnBehalfOfContentOwnerChannel = Nothing , _sId = Nothing , _sMySubscribers = Nothing , _sForChannelId = Nothing , _sPageToken = Nothing , _sOrder = SLORelevance , _sMaxResults = 5 } -- | The part parameter specifies a comma-separated list of one or more -- subscription resource properties that the API response will include. If -- the parameter identifies a property that contains child properties, the -- child properties will be included in the response. For example, in a -- subscription resource, the snippet property contains other properties, -- such as a display title for the subscription. If you set part=snippet, -- the API response will also contain all of those nested properties. sPart :: Lens' SubscriptionsList Text sPart = lens _sPart (\ s a -> s{_sPart = a}) -- | Set this parameter\'s value to true to retrieve a feed of the -- authenticated user\'s subscriptions. sMine :: Lens' SubscriptionsList (Maybe Bool) sMine = lens _sMine (\ s a -> s{_sMine = a}) -- | The channelId parameter specifies a YouTube channel ID. The API will -- only return that channel\'s subscriptions. sChannelId :: Lens' SubscriptionsList (Maybe Text) sChannelId = lens _sChannelId (\ s a -> s{_sChannelId = a}) -- | Note: This parameter is intended exclusively for YouTube content -- partners. The onBehalfOfContentOwner parameter indicates that the -- request\'s authorization credentials identify a YouTube CMS user who is -- acting on behalf of the content owner specified in the parameter value. -- This parameter is intended for YouTube content partners that own and -- manage many different YouTube channels. It allows content owners to -- authenticate once and get access to all their video and channel data, -- without having to provide authentication credentials for each individual -- channel. The CMS account that the user authenticates with must be linked -- to the specified YouTube content owner. sOnBehalfOfContentOwner :: Lens' SubscriptionsList (Maybe Text) sOnBehalfOfContentOwner = lens _sOnBehalfOfContentOwner (\ s a -> s{_sOnBehalfOfContentOwner = a}) -- | This parameter can only be used in a properly authorized request. Note: -- This parameter is intended exclusively for YouTube content partners. The -- onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID -- of the channel to which a video is being added. This parameter is -- required when a request specifies a value for the onBehalfOfContentOwner -- parameter, and it can only be used in conjunction with that parameter. -- In addition, the request must be authorized using a CMS account that is -- linked to the content owner that the onBehalfOfContentOwner parameter -- specifies. Finally, the channel that the onBehalfOfContentOwnerChannel -- parameter value specifies must be linked to the content owner that the -- onBehalfOfContentOwner parameter specifies. This parameter is intended -- for YouTube content partners that own and manage many different YouTube -- channels. It allows content owners to authenticate once and perform -- actions on behalf of the channel specified in the parameter value, -- without having to provide authentication credentials for each separate -- channel. sOnBehalfOfContentOwnerChannel :: Lens' SubscriptionsList (Maybe Text) sOnBehalfOfContentOwnerChannel = lens _sOnBehalfOfContentOwnerChannel (\ s a -> s{_sOnBehalfOfContentOwnerChannel = a}) -- | The id parameter specifies a comma-separated list of the YouTube -- subscription ID(s) for the resource(s) that are being retrieved. In a -- subscription resource, the id property specifies the YouTube -- subscription ID. sId :: Lens' SubscriptionsList (Maybe Text) sId = lens _sId (\ s a -> s{_sId = a}) -- | Set this parameter\'s value to true to retrieve a feed of the -- subscribers of the authenticated user. sMySubscribers :: Lens' SubscriptionsList (Maybe Bool) sMySubscribers = lens _sMySubscribers (\ s a -> s{_sMySubscribers = a}) -- | The forChannelId parameter specifies a comma-separated list of channel -- IDs. The API response will then only contain subscriptions matching -- those channels. sForChannelId :: Lens' SubscriptionsList (Maybe Text) sForChannelId = lens _sForChannelId (\ s a -> s{_sForChannelId = a}) -- | The pageToken parameter identifies a specific page in the result set -- that should be returned. In an API response, the nextPageToken and -- prevPageToken properties identify other pages that could be retrieved. sPageToken :: Lens' SubscriptionsList (Maybe Text) sPageToken = lens _sPageToken (\ s a -> s{_sPageToken = a}) -- | The order parameter specifies the method that will be used to sort -- resources in the API response. sOrder :: Lens' SubscriptionsList SubscriptionsListOrder sOrder = lens _sOrder (\ s a -> s{_sOrder = a}) -- | The maxResults parameter specifies the maximum number of items that -- should be returned in the result set. sMaxResults :: Lens' SubscriptionsList Word32 sMaxResults = lens _sMaxResults (\ s a -> s{_sMaxResults = a}) . _Coerce instance GoogleRequest SubscriptionsList where type Rs SubscriptionsList = SubscriptionListResponse requestClient SubscriptionsList{..} = go (Just _sPart) _sMine _sChannelId _sOnBehalfOfContentOwner _sOnBehalfOfContentOwnerChannel _sId _sMySubscribers _sForChannelId _sPageToken (Just _sOrder) (Just _sMaxResults) (Just AltJSON) youTubeService where go = buildClient (Proxy :: Proxy SubscriptionsListResource) mempty