gogol-apps-reseller-0.4.0: Google Enterprise Apps Reseller SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Reseller.Subscriptions.List

Contents

Description

List of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer's subscriptions, or all of a customer's transferable subscriptions.

See: Enterprise Apps Reseller API Reference for reseller.subscriptions.list.

Synopsis

REST Resource

type SubscriptionsListResource = "apps" :> ("reseller" :> ("v1" :> ("subscriptions" :> (QueryParam "customerNamePrefix" Text :> (QueryParam "customerId" Text :> (QueryParam "customerAuthToken" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] Subscriptions))))))))) Source #

A resource alias for reseller.subscriptions.list method which the SubscriptionsList request conforms to.

Creating a Request

subscriptionsList :: SubscriptionsList Source #

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:

data SubscriptionsList Source #

List of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer's subscriptions, or all of a customer's transferable subscriptions.

See: subscriptionsList smart constructor.

Instances
Eq SubscriptionsList Source # 
Instance details

Defined in Network.Google.Resource.Reseller.Subscriptions.List

Data SubscriptionsList Source # 
Instance details

Defined in Network.Google.Resource.Reseller.Subscriptions.List

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SubscriptionsList -> c SubscriptionsList #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SubscriptionsList #

toConstr :: SubscriptionsList -> Constr #

dataTypeOf :: SubscriptionsList -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SubscriptionsList) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SubscriptionsList) #

gmapT :: (forall b. Data b => b -> b) -> SubscriptionsList -> SubscriptionsList #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SubscriptionsList -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SubscriptionsList -> r #

gmapQ :: (forall d. Data d => d -> u) -> SubscriptionsList -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SubscriptionsList -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SubscriptionsList -> m SubscriptionsList #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SubscriptionsList -> m SubscriptionsList #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SubscriptionsList -> m SubscriptionsList #

Show SubscriptionsList Source # 
Instance details

Defined in Network.Google.Resource.Reseller.Subscriptions.List

Generic SubscriptionsList Source # 
Instance details

Defined in Network.Google.Resource.Reseller.Subscriptions.List

Associated Types

type Rep SubscriptionsList :: Type -> Type #

GoogleRequest SubscriptionsList Source # 
Instance details

Defined in Network.Google.Resource.Reseller.Subscriptions.List

Associated Types

type Rs SubscriptionsList :: Type #

type Scopes SubscriptionsList :: [Symbol] #

type Rep SubscriptionsList Source # 
Instance details

Defined in Network.Google.Resource.Reseller.Subscriptions.List

type Rep SubscriptionsList = D1 (MetaData "SubscriptionsList" "Network.Google.Resource.Reseller.Subscriptions.List" "gogol-apps-reseller-0.4.0-KDuipGWXeWG9naMHX80l3C" False) (C1 (MetaCons "SubscriptionsList'" PrefixI True) ((S1 (MetaSel (Just "_slCustomerNamePrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_slCustomerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_slCustomerAuthToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_slPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_slMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32)))))))
type Scopes SubscriptionsList Source # 
Instance details

Defined in Network.Google.Resource.Reseller.Subscriptions.List

type Scopes SubscriptionsList = "https://www.googleapis.com/auth/apps.order" ': ("https://www.googleapis.com/auth/apps.order.readonly" ': ([] :: [Symbol]))
type Rs SubscriptionsList Source # 
Instance details

Defined in Network.Google.Resource.Reseller.Subscriptions.List

Request Lenses

slCustomerNamePrefix :: Lens' SubscriptionsList (Maybe Text) Source #

When retrieving all of your subscriptions and filtering for specific customers, you can enter a prefix for a customer name. Using an example customer group that includes exam.com, example20.com and example.com: - exa -- Returns all customer names that start with 'exa' which could include exam.com, example20.com, and example.com. A name prefix is similar to using a regular expression's asterisk, exa*. - example -- Returns example20.com and example.com.

slCustomerId :: Lens' SubscriptionsList (Maybe Text) Source #

Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.

slCustomerAuthToken :: Lens' SubscriptionsList (Maybe Text) Source #

The customerAuthToken query string is required when creating a resold account that transfers a direct customer's subscription or transfers another reseller customer's subscription to your reseller management. This is a hexadecimal authentication token needed to complete the subscription transfer. For more information, see the administrator help center.

slPageToken :: Lens' SubscriptionsList (Maybe Text) Source #

Token to specify next page in the list

slMaxResults :: Lens' SubscriptionsList (Maybe Word32) Source #

When retrieving a large list, the maxResults is the maximum number of results per page. The nextPageToken value takes you to the next page. The default is 20.