Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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
- 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)))))))))
- subscriptionsList :: SubscriptionsList
- data SubscriptionsList
- slCustomerNamePrefix :: Lens' SubscriptionsList (Maybe Text)
- slCustomerId :: Lens' SubscriptionsList (Maybe Text)
- slCustomerAuthToken :: Lens' SubscriptionsList (Maybe Text)
- slPageToken :: Lens' SubscriptionsList (Maybe Text)
- slMaxResults :: Lens' SubscriptionsList (Maybe Word32)
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
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.