Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(1306)

Unified Diff: generated/googleapis/lib/reseller/v1.dart

Issue 3006323002: Api-Roll 54: 2017-09-11 (Closed)
Patch Set: use 2.0.0-dev.infinity sdk constraint in pubspecs Created 3 years, 3 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « generated/googleapis/lib/qpxexpress/v1.dart ('k') | generated/googleapis/lib/runtimeconfig/v1.dart » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: generated/googleapis/lib/reseller/v1.dart
diff --git a/generated/googleapis/lib/reseller/v1.dart b/generated/googleapis/lib/reseller/v1.dart
index f4e1b90b6319be32dc03a78b6229697fbdebc99b..b6d667639ecc143a53cfb5e053b9c6b3a3e30c45 100644
--- a/generated/googleapis/lib/reseller/v1.dart
+++ b/generated/googleapis/lib/reseller/v1.dart
@@ -9,55 +9,57 @@ import 'dart:convert' as convert;
import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons;
import 'package:http/http.dart' as http;
-export 'package:_discoveryapis_commons/_discoveryapis_commons.dart' show
- ApiRequestError, DetailedApiRequestError;
+export 'package:_discoveryapis_commons/_discoveryapis_commons.dart'
+ show ApiRequestError, DetailedApiRequestError;
const core.String USER_AGENT = 'dart-api-client reseller/v1';
-/** Creates and manages your customers and their subscriptions. */
+/// Creates and manages your customers and their subscriptions.
class ResellerApi {
- /** Manage users on your domain */
+ /// Manage users on your domain
static const AppsOrderScope = "https://www.googleapis.com/auth/apps.order";
- /** Manage users on your domain */
- static const AppsOrderReadonlyScope = "https://www.googleapis.com/auth/apps.order.readonly";
-
+ /// Manage users on your domain
+ static const AppsOrderReadonlyScope =
+ "https://www.googleapis.com/auth/apps.order.readonly";
final commons.ApiRequester _requester;
CustomersResourceApi get customers => new CustomersResourceApi(_requester);
- ResellernotifyResourceApi get resellernotify => new ResellernotifyResourceApi(_requester);
- SubscriptionsResourceApi get subscriptions => new SubscriptionsResourceApi(_requester);
-
- ResellerApi(http.Client client, {core.String rootUrl: "https://www.googleapis.com/", core.String servicePath: "apps/reseller/v1/"}) :
- _requester = new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT);
+ ResellernotifyResourceApi get resellernotify =>
+ new ResellernotifyResourceApi(_requester);
+ SubscriptionsResourceApi get subscriptions =>
+ new SubscriptionsResourceApi(_requester);
+
+ ResellerApi(http.Client client,
+ {core.String rootUrl: "https://www.googleapis.com/",
+ core.String servicePath: "apps/reseller/v1/"})
+ : _requester =
+ new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT);
}
-
class CustomersResourceApi {
final commons.ApiRequester _requester;
- CustomersResourceApi(commons.ApiRequester client) :
- _requester = client;
-
- /**
- * Get a customer account.
- *
- * Request parameters:
- *
- * [customerId] - 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.
- *
- * Completes with a [Customer].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
+ CustomersResourceApi(commons.ApiRequester client) : _requester = client;
+
+ /// Get a customer account.
+ ///
+ /// Request parameters:
+ ///
+ /// [customerId] - 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.
+ ///
+ /// Completes with a [Customer].
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
async.Future<Customer> get(core.String customerId) {
var _url = null;
var _queryParams = new core.Map();
@@ -72,39 +74,37 @@ class CustomersResourceApi {
_url = 'customers/' + commons.Escaper.ecapeVariable('$customerId');
- var _response = _requester.request(_url,
- "GET",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "GET",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Customer.fromJson(data));
}
- /**
- * Order a new customer's account.
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [customerAuthToken] - 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.
- *
- * Completes with a [Customer].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
- async.Future<Customer> insert(Customer request, {core.String customerAuthToken}) {
+ /// Order a new customer's account.
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [customerAuthToken] - 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.
+ ///
+ /// Completes with a [Customer].
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
+ async.Future<Customer> insert(Customer request,
+ {core.String customerAuthToken}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -121,36 +121,35 @@ class CustomersResourceApi {
_url = 'customers';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Customer.fromJson(data));
}
- /**
- * Update a customer account's settings. This method supports patch semantics.
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [customerId] - 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.
- *
- * Completes with a [Customer].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
+ /// Update a customer account's settings. This method supports patch
+ /// semantics.
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [customerId] - 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.
+ ///
+ /// Completes with a [Customer].
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
async.Future<Customer> patch(Customer request, core.String customerId) {
var _url = null;
var _queryParams = new core.Map();
@@ -168,36 +167,34 @@ class CustomersResourceApi {
_url = 'customers/' + commons.Escaper.ecapeVariable('$customerId');
- var _response = _requester.request(_url,
- "PATCH",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "PATCH",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Customer.fromJson(data));
}
- /**
- * Update a customer account's settings.
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [customerId] - 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.
- *
- * Completes with a [Customer].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
+ /// Update a customer account's settings.
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [customerId] - 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.
+ ///
+ /// Completes with a [Customer].
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
async.Future<Customer> update(Customer request, core.String customerId) {
var _url = null;
var _queryParams = new core.Map();
@@ -215,38 +212,32 @@ class CustomersResourceApi {
_url = 'customers/' + commons.Escaper.ecapeVariable('$customerId');
- var _response = _requester.request(_url,
- "PUT",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "PUT",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Customer.fromJson(data));
}
-
}
-
class ResellernotifyResourceApi {
final commons.ApiRequester _requester;
- ResellernotifyResourceApi(commons.ApiRequester client) :
- _requester = client;
-
- /**
- * Returns all the details of the watch corresponding to the reseller.
- *
- * Request parameters:
- *
- * Completes with a [ResellernotifyGetwatchdetailsResponse].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
+ ResellernotifyResourceApi(commons.ApiRequester client) : _requester = client;
+
+ /// Returns all the details of the watch corresponding to the reseller.
+ ///
+ /// Request parameters:
+ ///
+ /// Completes with a [ResellernotifyGetwatchdetailsResponse].
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
async.Future<ResellernotifyGetwatchdetailsResponse> getwatchdetails() {
var _url = null;
var _queryParams = new core.Map();
@@ -255,36 +246,34 @@ class ResellernotifyResourceApi {
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body = null;
-
_url = 'resellernotify/getwatchdetails';
- var _response = _requester.request(_url,
- "GET",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
- return _response.then((data) => new ResellernotifyGetwatchdetailsResponse.fromJson(data));
+ var _response = _requester.request(_url, "GET",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
+ return _response.then(
+ (data) => new ResellernotifyGetwatchdetailsResponse.fromJson(data));
}
- /**
- * Registers a Reseller for receiving notifications.
- *
- * Request parameters:
- *
- * [serviceAccountEmailAddress] - The service account which will own the
- * created Cloud-PubSub topic.
- *
- * Completes with a [ResellernotifyResource].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
- async.Future<ResellernotifyResource> register({core.String serviceAccountEmailAddress}) {
+ /// Registers a Reseller for receiving notifications.
+ ///
+ /// Request parameters:
+ ///
+ /// [serviceAccountEmailAddress] - The service account which will own the
+ /// created Cloud-PubSub topic.
+ ///
+ /// Completes with a [ResellernotifyResource].
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
+ async.Future<ResellernotifyResource> register(
+ {core.String serviceAccountEmailAddress}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -298,33 +287,31 @@ class ResellernotifyResourceApi {
_url = 'resellernotify/register';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new ResellernotifyResource.fromJson(data));
}
- /**
- * Unregisters a Reseller for receiving notifications.
- *
- * Request parameters:
- *
- * [serviceAccountEmailAddress] - The service account which owns the
- * Cloud-PubSub topic.
- *
- * Completes with a [ResellernotifyResource].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
- async.Future<ResellernotifyResource> unregister({core.String serviceAccountEmailAddress}) {
+ /// Unregisters a Reseller for receiving notifications.
+ ///
+ /// Request parameters:
+ ///
+ /// [serviceAccountEmailAddress] - The service account which owns the
+ /// Cloud-PubSub topic.
+ ///
+ /// Completes with a [ResellernotifyResource].
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
+ async.Future<ResellernotifyResource> unregister(
+ {core.String serviceAccountEmailAddress}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -338,50 +325,46 @@ class ResellernotifyResourceApi {
_url = 'resellernotify/unregister';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new ResellernotifyResource.fromJson(data));
}
-
}
-
class SubscriptionsResourceApi {
final commons.ApiRequester _requester;
- SubscriptionsResourceApi(commons.ApiRequester client) :
- _requester = client;
-
- /**
- * Activates a subscription previously suspended by the reseller
- *
- * Request parameters:
- *
- * [customerId] - 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.
- *
- * [subscriptionId] - This is a required property. The subscriptionId is the
- * subscription identifier and is unique for each customer. Since a
- * subscriptionId changes when a subscription is updated, we recommend to not
- * use this ID as a key for persistent data. And the subscriptionId can be
- * found using the retrieve all reseller subscriptions method.
- *
- * Completes with a [Subscription].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
- async.Future<Subscription> activate(core.String customerId, core.String subscriptionId) {
+ SubscriptionsResourceApi(commons.ApiRequester client) : _requester = client;
+
+ /// Activates a subscription previously suspended by the reseller
+ ///
+ /// Request parameters:
+ ///
+ /// [customerId] - 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.
+ ///
+ /// [subscriptionId] - This is a required property. The subscriptionId is the
+ /// subscription identifier and is unique for each customer. Since a
+ /// subscriptionId changes when a subscription is updated, we recommend to
+ /// not use this ID as a key for persistent data. And the subscriptionId can
+ /// be found using the retrieve all reseller subscriptions method.
+ ///
+ /// Completes with a [Subscription].
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
+ async.Future<Subscription> activate(
+ core.String customerId, core.String subscriptionId) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -396,47 +379,50 @@ class SubscriptionsResourceApi {
throw new core.ArgumentError("Parameter subscriptionId is required.");
}
- _url = 'customers/' + commons.Escaper.ecapeVariable('$customerId') + '/subscriptions/' + commons.Escaper.ecapeVariable('$subscriptionId') + '/activate';
+ _url = 'customers/' +
+ commons.Escaper.ecapeVariable('$customerId') +
+ '/subscriptions/' +
+ commons.Escaper.ecapeVariable('$subscriptionId') +
+ '/activate';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Subscription.fromJson(data));
}
- /**
- * Update a subscription plan. Use this method to update a plan for a 30-day
- * trial or a flexible plan subscription to an annual commitment plan with
- * monthly or yearly payments.
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [customerId] - 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.
- *
- * [subscriptionId] - This is a required property. The subscriptionId is the
- * subscription identifier and is unique for each customer. Since a
- * subscriptionId changes when a subscription is updated, we recommend to not
- * use this ID as a key for persistent data. And the subscriptionId can be
- * found using the retrieve all reseller subscriptions method.
- *
- * Completes with a [Subscription].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
- async.Future<Subscription> changePlan(ChangePlanRequest request, core.String customerId, core.String subscriptionId) {
+ /// Update a subscription plan. Use this method to update a plan for a 30-day
+ /// trial or a flexible plan subscription to an annual commitment plan with
+ /// monthly or yearly payments.
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [customerId] - 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.
+ ///
+ /// [subscriptionId] - This is a required property. The subscriptionId is the
+ /// subscription identifier and is unique for each customer. Since a
+ /// subscriptionId changes when a subscription is updated, we recommend to
+ /// not use this ID as a key for persistent data. And the subscriptionId can
+ /// be found using the retrieve all reseller subscriptions method.
+ ///
+ /// Completes with a [Subscription].
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
+ async.Future<Subscription> changePlan(ChangePlanRequest request,
+ core.String customerId, core.String subscriptionId) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -454,46 +440,49 @@ class SubscriptionsResourceApi {
throw new core.ArgumentError("Parameter subscriptionId is required.");
}
- _url = 'customers/' + commons.Escaper.ecapeVariable('$customerId') + '/subscriptions/' + commons.Escaper.ecapeVariable('$subscriptionId') + '/changePlan';
+ _url = 'customers/' +
+ commons.Escaper.ecapeVariable('$customerId') +
+ '/subscriptions/' +
+ commons.Escaper.ecapeVariable('$subscriptionId') +
+ '/changePlan';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Subscription.fromJson(data));
}
- /**
- * Update a user license's renewal settings. This is applicable for accounts
- * with annual commitment plans only.
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [customerId] - 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.
- *
- * [subscriptionId] - This is a required property. The subscriptionId is the
- * subscription identifier and is unique for each customer. Since a
- * subscriptionId changes when a subscription is updated, we recommend to not
- * use this ID as a key for persistent data. And the subscriptionId can be
- * found using the retrieve all reseller subscriptions method.
- *
- * Completes with a [Subscription].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
- async.Future<Subscription> changeRenewalSettings(RenewalSettings request, core.String customerId, core.String subscriptionId) {
+ /// Update a user license's renewal settings. This is applicable for accounts
+ /// with annual commitment plans only.
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [customerId] - 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.
+ ///
+ /// [subscriptionId] - This is a required property. The subscriptionId is the
+ /// subscription identifier and is unique for each customer. Since a
+ /// subscriptionId changes when a subscription is updated, we recommend to
+ /// not use this ID as a key for persistent data. And the subscriptionId can
+ /// be found using the retrieve all reseller subscriptions method.
+ ///
+ /// Completes with a [Subscription].
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
+ async.Future<Subscription> changeRenewalSettings(RenewalSettings request,
+ core.String customerId, core.String subscriptionId) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -511,45 +500,48 @@ class SubscriptionsResourceApi {
throw new core.ArgumentError("Parameter subscriptionId is required.");
}
- _url = 'customers/' + commons.Escaper.ecapeVariable('$customerId') + '/subscriptions/' + commons.Escaper.ecapeVariable('$subscriptionId') + '/changeRenewalSettings';
+ _url = 'customers/' +
+ commons.Escaper.ecapeVariable('$customerId') +
+ '/subscriptions/' +
+ commons.Escaper.ecapeVariable('$subscriptionId') +
+ '/changeRenewalSettings';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Subscription.fromJson(data));
}
- /**
- * Update a subscription's user license settings.
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [customerId] - 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.
- *
- * [subscriptionId] - This is a required property. The subscriptionId is the
- * subscription identifier and is unique for each customer. Since a
- * subscriptionId changes when a subscription is updated, we recommend to not
- * use this ID as a key for persistent data. And the subscriptionId can be
- * found using the retrieve all reseller subscriptions method.
- *
- * Completes with a [Subscription].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
- async.Future<Subscription> changeSeats(Seats request, core.String customerId, core.String subscriptionId) {
+ /// Update a subscription's user license settings.
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [customerId] - 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.
+ ///
+ /// [subscriptionId] - This is a required property. The subscriptionId is the
+ /// subscription identifier and is unique for each customer. Since a
+ /// subscriptionId changes when a subscription is updated, we recommend to
+ /// not use this ID as a key for persistent data. And the subscriptionId can
+ /// be found using the retrieve all reseller subscriptions method.
+ ///
+ /// Completes with a [Subscription].
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
+ async.Future<Subscription> changeSeats(
+ Seats request, core.String customerId, core.String subscriptionId) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -567,74 +559,78 @@ class SubscriptionsResourceApi {
throw new core.ArgumentError("Parameter subscriptionId is required.");
}
- _url = 'customers/' + commons.Escaper.ecapeVariable('$customerId') + '/subscriptions/' + commons.Escaper.ecapeVariable('$subscriptionId') + '/changeSeats';
+ _url = 'customers/' +
+ commons.Escaper.ecapeVariable('$customerId') +
+ '/subscriptions/' +
+ commons.Escaper.ecapeVariable('$subscriptionId') +
+ '/changeSeats';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Subscription.fromJson(data));
}
- /**
- * Cancel, suspend or transfer a subscription to direct.
- *
- * Request parameters:
- *
- * [customerId] - 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.
- *
- * [subscriptionId] - This is a required property. The subscriptionId is the
- * subscription identifier and is unique for each customer. Since a
- * subscriptionId changes when a subscription is updated, we recommend to not
- * use this ID as a key for persistent data. And the subscriptionId can be
- * found using the retrieve all reseller subscriptions method.
- *
- * [deletionType] - The deletionType query string enables the cancellation,
- * downgrade, or suspension of a subscription.
- * Possible string values are:
- * - "cancel" : Cancels the subscription immediately. This does not apply to a
- * G Suite subscription.
- * - "downgrade" : Downgrades a G Suite subscription to a Google Apps Free
- * edition subscription only if the customer was initially subscribed to a
- * Google Apps Free edition (also known as the Standard edition). Once
- * downgraded, the customer no longer has access to the previous G Suite
- * subscription and is no longer managed by the reseller.
- *
- * A G Suite subscription's downgrade cannot be invoked if an active or
- * suspended Google Drive or Google Vault subscription is present. The Google
- * Drive or Google Vault subscription must be cancelled before the G Suite
- * subscription's downgrade is invoked.
- *
- * The downgrade deletionType does not apply to other products or G Suite
- * SKUs.
- * - "suspend" : (DEPRECATED) The G Suite account is suspended for four days
- * and then cancelled. Once suspended, an administrator has access to the
- * suspended account, but the account users can not access their services. A
- * suspension can be lifted, using the reseller tools.
- *
- * A G Suite subscription's suspension can not be invoked if an active or
- * suspended Google Drive or Google Vault subscription is present. The Google
- * Drive or Google Vault subscription must be cancelled before the G Suite
- * subscription's suspension is invoked.
- * - "transfer_to_direct" : Transfers a subscription directly to Google.  The
- * customer is immediately transferred to a direct billing relationship with
- * Google and is given a short amount of time with no service interruption.
- * The customer can then choose to set up billing directly with Google by
- * using a credit card, or they can transfer to another reseller.
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
- async.Future delete(core.String customerId, core.String subscriptionId, core.String deletionType) {
+ /// Cancel, suspend or transfer a subscription to direct.
+ ///
+ /// Request parameters:
+ ///
+ /// [customerId] - 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.
+ ///
+ /// [subscriptionId] - This is a required property. The subscriptionId is the
+ /// subscription identifier and is unique for each customer. Since a
+ /// subscriptionId changes when a subscription is updated, we recommend to
+ /// not use this ID as a key for persistent data. And the subscriptionId can
+ /// be found using the retrieve all reseller subscriptions method.
+ ///
+ /// [deletionType] - The deletionType query string enables the cancellation,
+ /// downgrade, or suspension of a subscription.
+ /// Possible string values are:
+ /// - "cancel" : Cancels the subscription immediately. This does not apply to
+ /// a G Suite subscription.
+ /// - "downgrade" : Downgrades a G Suite subscription to a Google Apps Free
+ /// edition subscription only if the customer was initially subscribed to a
+ /// Google Apps Free edition (also known as the Standard edition). Once
+ /// downgraded, the customer no longer has access to the previous G Suite
+ /// subscription and is no longer managed by the reseller.
+ ///
+ /// A G Suite subscription's downgrade cannot be invoked if an active or
+ /// suspended Google Drive or Google Vault subscription is present. The
+ /// Google Drive or Google Vault subscription must be cancelled before the G
+ /// Suite subscription's downgrade is invoked.
+ ///
+ /// The downgrade deletionType does not apply to other products or G Suite
+ /// SKUs.
+ /// - "suspend" : (DEPRECATED) The G Suite account is suspended for four days
+ /// and then cancelled. Once suspended, an administrator has access to the
+ /// suspended account, but the account users can not access their services. A
+ /// suspension can be lifted, using the reseller tools.
+ ///
+ /// A G Suite subscription's suspension can not be invoked if an active or
+ /// suspended Google Drive or Google Vault subscription is present. The
+ /// Google Drive or Google Vault subscription must be cancelled before the G
+ /// Suite subscription's suspension is invoked.
+ /// - "transfer_to_direct" : Transfers a subscription directly to
+ /// Google.  The customer is immediately transferred to a direct billing
+ /// relationship with Google and is given a short amount of time with no
+ /// service interruption. The customer can then choose to set up billing
+ /// directly with Google by using a credit card, or they can transfer to
+ /// another reseller.
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
+ async.Future delete(core.String customerId, core.String subscriptionId,
+ core.String deletionType) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -655,43 +651,45 @@ class SubscriptionsResourceApi {
_downloadOptions = null;
- _url = 'customers/' + commons.Escaper.ecapeVariable('$customerId') + '/subscriptions/' + commons.Escaper.ecapeVariable('$subscriptionId');
-
- var _response = _requester.request(_url,
- "DELETE",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ _url = 'customers/' +
+ commons.Escaper.ecapeVariable('$customerId') +
+ '/subscriptions/' +
+ commons.Escaper.ecapeVariable('$subscriptionId');
+
+ var _response = _requester.request(_url, "DELETE",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => null);
}
- /**
- * Get a specific subscription.
- *
- * Request parameters:
- *
- * [customerId] - 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.
- *
- * [subscriptionId] - This is a required property. The subscriptionId is the
- * subscription identifier and is unique for each customer. Since a
- * subscriptionId changes when a subscription is updated, we recommend to not
- * use this ID as a key for persistent data. And the subscriptionId can be
- * found using the retrieve all reseller subscriptions method.
- *
- * Completes with a [Subscription].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
- async.Future<Subscription> get(core.String customerId, core.String subscriptionId) {
+ /// Get a specific subscription.
+ ///
+ /// Request parameters:
+ ///
+ /// [customerId] - 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.
+ ///
+ /// [subscriptionId] - This is a required property. The subscriptionId is the
+ /// subscription identifier and is unique for each customer. Since a
+ /// subscriptionId changes when a subscription is updated, we recommend to
+ /// not use this ID as a key for persistent data. And the subscriptionId can
+ /// be found using the retrieve all reseller subscriptions method.
+ ///
+ /// Completes with a [Subscription].
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
+ async.Future<Subscription> get(
+ core.String customerId, core.String subscriptionId) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -706,46 +704,49 @@ class SubscriptionsResourceApi {
throw new core.ArgumentError("Parameter subscriptionId is required.");
}
- _url = 'customers/' + commons.Escaper.ecapeVariable('$customerId') + '/subscriptions/' + commons.Escaper.ecapeVariable('$subscriptionId');
+ _url = 'customers/' +
+ commons.Escaper.ecapeVariable('$customerId') +
+ '/subscriptions/' +
+ commons.Escaper.ecapeVariable('$subscriptionId');
- var _response = _requester.request(_url,
- "GET",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "GET",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Subscription.fromJson(data));
}
- /**
- * Create or transfer a subscription.
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [customerId] - 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.
- *
- * [customerAuthToken] - 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.
- *
- * Completes with a [Subscription].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
- async.Future<Subscription> insert(Subscription request, core.String customerId, {core.String customerAuthToken}) {
+ /// Create or transfer a subscription.
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [customerId] - 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.
+ ///
+ /// [customerAuthToken] - 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.
+ ///
+ /// Completes with a [Subscription].
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
+ async.Future<Subscription> insert(
+ Subscription request, core.String customerId,
+ {core.String customerAuthToken}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -763,62 +764,67 @@ class SubscriptionsResourceApi {
_queryParams["customerAuthToken"] = [customerAuthToken];
}
- _url = 'customers/' + commons.Escaper.ecapeVariable('$customerId') + '/subscriptions';
+ _url = 'customers/' +
+ commons.Escaper.ecapeVariable('$customerId') +
+ '/subscriptions';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Subscription.fromJson(data));
}
- /**
- * 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.
- *
- * Request parameters:
- *
- * [customerAuthToken] - 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.
- *
- * [customerId] - 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.
- *
- * [customerNamePrefix] - 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.
- *
- * [maxResults] - 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.
- * Value must be between "1" and "100".
- *
- * [pageToken] - Token to specify next page in the list
- *
- * Completes with a [Subscriptions].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
- async.Future<Subscriptions> list({core.String customerAuthToken, core.String customerId, core.String customerNamePrefix, core.int maxResults, core.String pageToken}) {
+ /// 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.
+ ///
+ /// Request parameters:
+ ///
+ /// [customerAuthToken] - 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.
+ ///
+ /// [customerId] - 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.
+ ///
+ /// [customerNamePrefix] - 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.
+ ///
+ /// [maxResults] - 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.
+ /// Value must be between "1" and "100".
+ ///
+ /// [pageToken] - Token to specify next page in the list
+ ///
+ /// Completes with a [Subscriptions].
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
+ async.Future<Subscriptions> list(
+ {core.String customerAuthToken,
+ core.String customerId,
+ core.String customerNamePrefix,
+ core.int maxResults,
+ core.String pageToken}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -844,42 +850,41 @@ class SubscriptionsResourceApi {
_url = 'subscriptions';
- var _response = _requester.request(_url,
- "GET",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "GET",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Subscriptions.fromJson(data));
}
- /**
- * Immediately move a 30-day free trial subscription to a paid service
- * subscription.
- *
- * Request parameters:
- *
- * [customerId] - 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.
- *
- * [subscriptionId] - This is a required property. The subscriptionId is the
- * subscription identifier and is unique for each customer. Since a
- * subscriptionId changes when a subscription is updated, we recommend to not
- * use this ID as a key for persistent data. And the subscriptionId can be
- * found using the retrieve all reseller subscriptions method.
- *
- * Completes with a [Subscription].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
- async.Future<Subscription> startPaidService(core.String customerId, core.String subscriptionId) {
+ /// Immediately move a 30-day free trial subscription to a paid service
+ /// subscription.
+ ///
+ /// Request parameters:
+ ///
+ /// [customerId] - 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.
+ ///
+ /// [subscriptionId] - This is a required property. The subscriptionId is the
+ /// subscription identifier and is unique for each customer. Since a
+ /// subscriptionId changes when a subscription is updated, we recommend to
+ /// not use this ID as a key for persistent data. And the subscriptionId can
+ /// be found using the retrieve all reseller subscriptions method.
+ ///
+ /// Completes with a [Subscription].
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
+ async.Future<Subscription> startPaidService(
+ core.String customerId, core.String subscriptionId) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -894,43 +899,46 @@ class SubscriptionsResourceApi {
throw new core.ArgumentError("Parameter subscriptionId is required.");
}
- _url = 'customers/' + commons.Escaper.ecapeVariable('$customerId') + '/subscriptions/' + commons.Escaper.ecapeVariable('$subscriptionId') + '/startPaidService';
+ _url = 'customers/' +
+ commons.Escaper.ecapeVariable('$customerId') +
+ '/subscriptions/' +
+ commons.Escaper.ecapeVariable('$subscriptionId') +
+ '/startPaidService';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Subscription.fromJson(data));
}
- /**
- * Suspends an active subscription.
- *
- * Request parameters:
- *
- * [customerId] - 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.
- *
- * [subscriptionId] - This is a required property. The subscriptionId is the
- * subscription identifier and is unique for each customer. Since a
- * subscriptionId changes when a subscription is updated, we recommend to not
- * use this ID as a key for persistent data. And the subscriptionId can be
- * found using the retrieve all reseller subscriptions method.
- *
- * Completes with a [Subscription].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
- async.Future<Subscription> suspend(core.String customerId, core.String subscriptionId) {
+ /// Suspends an active subscription.
+ ///
+ /// Request parameters:
+ ///
+ /// [customerId] - 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.
+ ///
+ /// [subscriptionId] - This is a required property. The subscriptionId is the
+ /// subscription identifier and is unique for each customer. Since a
+ /// subscriptionId changes when a subscription is updated, we recommend to
+ /// not use this ID as a key for persistent data. And the subscriptionId can
+ /// be found using the retrieve all reseller subscriptions method.
+ ///
+ /// Completes with a [Subscription].
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
+ async.Future<Subscription> suspend(
+ core.String customerId, core.String subscriptionId) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -945,55 +953,56 @@ class SubscriptionsResourceApi {
throw new core.ArgumentError("Parameter subscriptionId is required.");
}
- _url = 'customers/' + commons.Escaper.ecapeVariable('$customerId') + '/subscriptions/' + commons.Escaper.ecapeVariable('$subscriptionId') + '/suspend';
+ _url = 'customers/' +
+ commons.Escaper.ecapeVariable('$customerId') +
+ '/subscriptions/' +
+ commons.Escaper.ecapeVariable('$subscriptionId') +
+ '/suspend';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Subscription.fromJson(data));
}
-
}
-
-
-/** JSON template for address of a customer. */
+/// JSON template for address of a customer.
class Address {
- /**
- * A customer's physical address. An address can be composed of one to three
- * lines. The addressline2 and addressLine3 are optional.
- */
+ /// A customer's physical address. An address can be composed of one to three
+ /// lines. The addressline2 and addressLine3 are optional.
core.String addressLine1;
- /** Line 2 of the address. */
+
+ /// Line 2 of the address.
core.String addressLine2;
- /** Line 3 of the address. */
+
+ /// Line 3 of the address.
core.String addressLine3;
- /** The customer contact's name. This is required. */
+
+ /// The customer contact's name. This is required.
core.String contactName;
- /**
- * For countryCode information, see the ISO 3166 country code elements. Verify
- * that country is approved for resale of Google products. This property is
- * required when creating a new customer.
- */
+
+ /// For countryCode information, see the ISO 3166 country code elements.
+ /// Verify that country is approved for resale of Google products. This
+ /// property is required when creating a new customer.
core.String countryCode;
- /**
- * Identifies the resource as a customer address. Value: customers#address
- */
+
+ /// Identifies the resource as a customer address. Value: customers#address
core.String kind;
- /** An example of a locality value is the city of San Francisco. */
+
+ /// An example of a locality value is the city of San Francisco.
core.String locality;
- /** The company or company division name. This is required. */
+
+ /// The company or company division name. This is required.
core.String organizationName;
- /**
- * A postalCode example is a postal zip code such as 94043. This property is
- * required when creating a new customer.
- */
+
+ /// A postalCode example is a postal zip code such as 94043. This property is
+ /// required when creating a new customer.
core.String postalCode;
- /** An example of a region value is CA for the state of California. */
+
+ /// An example of a region value is CA for the state of California.
core.String region;
Address();
@@ -1032,7 +1041,8 @@ class Address {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (addressLine1 != null) {
_json["addressLine1"] = addressLine1;
}
@@ -1067,47 +1077,41 @@ class Address {
}
}
-/** JSON template for the ChangePlan rpc request. */
+/// JSON template for the ChangePlan rpc request.
class ChangePlanRequest {
- /**
- * Google-issued code (100 char max) for discounted pricing on subscription
- * plans. Deal code must be included in changePlan request in order to receive
- * discounted rate. This property is optional. If a deal code has already been
- * added to a subscription, this property may be left empty and the existing
- * discounted rate will still apply (if not empty, only provide the deal code
- * that is already present on the subscription). If a deal code has never been
- * added to a subscription and this property is left blank, regular pricing
- * will apply.
- */
+ /// Google-issued code (100 char max) for discounted pricing on subscription
+ /// plans. Deal code must be included in changePlan request in order to
+ /// receive discounted rate. This property is optional. If a deal code has
+ /// already been added to a subscription, this property may be left empty and
+ /// the existing discounted rate will still apply (if not empty, only provide
+ /// the deal code that is already present on the subscription). If a deal
+ /// code has never been added to a subscription and this property is left
+ /// blank, regular pricing will apply.
core.String dealCode;
- /**
- * Identifies the resource as a subscription change plan request. Value:
- * subscriptions#changePlanRequest
- */
+
+ /// Identifies the resource as a subscription change plan request. Value:
+ /// subscriptions#changePlanRequest
core.String kind;
- /**
- * The planName property is required. This is the name of the subscription's
- * payment plan. For more information about the Google payment plans, see API
- * concepts.
- *
- * Possible values are:
- * - ANNUAL_MONTHLY_PAY - The annual commitment plan with monthly payments
- * - ANNUAL_YEARLY_PAY - The annual commitment plan with yearly payments
- * - FLEXIBLE - The flexible plan
- * - TRIAL - The 30-day free trial plan
- */
+
+ /// The planName property is required. This is the name of the subscription's
+ /// payment plan. For more information about the Google payment plans, see
+ /// API concepts.
+ ///
+ /// Possible values are:
+ /// - ANNUAL_MONTHLY_PAY - The annual commitment plan with monthly payments
+ /// - ANNUAL_YEARLY_PAY - The annual commitment plan with yearly payments
+ /// - FLEXIBLE - The flexible plan
+ /// - TRIAL - The 30-day free trial plan
core.String planName;
- /**
- * This is an optional property. This purchase order (PO) information is for
- * resellers to use for their company tracking usage. If a purchaseOrderId
- * value is given it appears in the API responses and shows up in the invoice.
- * The property accepts up to 80 plain text characters.
- */
+
+ /// This is an optional property. This purchase order (PO) information is for
+ /// resellers to use for their company tracking usage. If a purchaseOrderId
+ /// value is given it appears in the API responses and shows up in the
+ /// invoice. The property accepts up to 80 plain text characters.
core.String purchaseOrderId;
- /**
- * This is a required property. The seats property is the number of user seat
- * licenses.
- */
+
+ /// This is a required property. The seats property is the number of user
+ /// seat licenses.
Seats seats;
ChangePlanRequest();
@@ -1131,7 +1135,8 @@ class ChangePlanRequest {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (dealCode != null) {
_json["dealCode"] = dealCode;
}
@@ -1151,47 +1156,43 @@ class ChangePlanRequest {
}
}
-/** JSON template for a customer. */
+/// JSON template for a customer.
class Customer {
- /**
- * Like the "Customer email" in the reseller tools, this email is the
- * secondary contact used if something happens to the customer's service such
- * as service outage or a security issue. This property is required when
- * creating a new customer and should not use the same domain as
- * customerDomain.
- */
+ /// Like the "Customer email" in the reseller tools, this email is the
+ /// secondary contact used if something happens to the customer's service
+ /// such as service outage or a security issue. This property is required
+ /// when creating a new customer and should not use the same domain as
+ /// customerDomain.
core.String alternateEmail;
- /**
- * The customer's primary domain name string. customerDomain is required when
- * creating a new customer. Do not include the www prefix in the domain when
- * adding a customer.
- */
+
+ /// The customer's primary domain name string. customerDomain is required
+ /// when creating a new customer. Do not include the www prefix in the domain
+ /// when adding a customer.
core.String customerDomain;
- /** Whether the customer's primary domain has been verified. */
+
+ /// Whether the customer's primary domain has been verified.
core.bool customerDomainVerified;
- /**
- * This property will always be returned in a response as the unique
- * identifier generated by Google. In a request, this property can be either
- * the primary domain or the unique identifier generated by Google.
- */
+
+ /// This property will always be returned in a response as the unique
+ /// identifier generated by Google. In a request, this property can be either
+ /// the primary domain or the unique identifier generated by Google.
core.String customerId;
- /** Identifies the resource as a customer. Value: reseller#customer */
+
+ /// Identifies the resource as a customer. Value: reseller#customer
core.String kind;
- /**
- * Customer contact phone number. This can be continuous numbers, with spaces,
- * etc. But it must be a real phone number and not, for example, "123". See
- * phone local format conventions.
- */
+
+ /// Customer contact phone number. This can be continuous numbers, with
+ /// spaces, etc. But it must be a real phone number and not, for example,
+ /// "123". See phone local format conventions.
core.String phoneNumber;
- /**
- * A customer's address information. Each field has a limit of 255 charcters.
- */
+
+ /// A customer's address information. Each field has a limit of 255
+ /// charcters.
Address postalAddress;
- /**
- * URL to customer's Admin console dashboard. The read-only URL is generated
- * by the API service. This is used if your client application requires the
- * customer to complete a task in the Admin console.
- */
+
+ /// URL to customer's Admin console dashboard. The read-only URL is generated
+ /// by the API service. This is used if your client application requires the
+ /// customer to complete a task in the Admin console.
core.String resourceUiUrl;
Customer();
@@ -1224,7 +1225,8 @@ class Customer {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (alternateEmail != null) {
_json["alternateEmail"] = alternateEmail;
}
@@ -1253,18 +1255,15 @@ class Customer {
}
}
-/** JSON template for a subscription renewal settings. */
+/// JSON template for a subscription renewal settings.
class RenewalSettings {
- /**
- * Identifies the resource as a subscription renewal setting. Value:
- * subscriptions#renewalSettings
- */
+ /// Identifies the resource as a subscription renewal setting. Value:
+ /// subscriptions#renewalSettings
core.String kind;
- /**
- * Renewal settings for the annual commitment plan. For more detailed
- * information, see renewal options in the administrator help center. When
- * renewing a subscription, the renewalType is a required property.
- */
+
+ /// Renewal settings for the annual commitment plan. For more detailed
+ /// information, see renewal options in the administrator help center. When
+ /// renewing a subscription, the renewalType is a required property.
core.String renewalType;
RenewalSettings();
@@ -1279,7 +1278,8 @@ class RenewalSettings {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (kind != null) {
_json["kind"] = kind;
}
@@ -1290,11 +1290,12 @@ class RenewalSettings {
}
}
-/** JSON template for resellernotify getwatchdetails response. */
+/// JSON template for resellernotify getwatchdetails response.
class ResellernotifyGetwatchdetailsResponse {
- /** List of registered service accounts. */
+ /// List of registered service accounts.
core.List<core.String> serviceAccountEmailAddresses;
- /** Topic name of the PubSub */
+
+ /// Topic name of the PubSub
core.String topicName;
ResellernotifyGetwatchdetailsResponse();
@@ -1309,7 +1310,8 @@ class ResellernotifyGetwatchdetailsResponse {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (serviceAccountEmailAddresses != null) {
_json["serviceAccountEmailAddresses"] = serviceAccountEmailAddresses;
}
@@ -1320,9 +1322,9 @@ class ResellernotifyGetwatchdetailsResponse {
}
}
-/** JSON template for resellernotify response. */
+/// JSON template for resellernotify response.
class ResellernotifyResource {
- /** Topic name of the PubSub */
+ /// Topic name of the PubSub
core.String topicName;
ResellernotifyResource();
@@ -1334,7 +1336,8 @@ class ResellernotifyResource {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (topicName != null) {
_json["topicName"] = topicName;
}
@@ -1342,55 +1345,50 @@ class ResellernotifyResource {
}
}
-/** JSON template for subscription seats. */
+/// JSON template for subscription seats.
class Seats {
- /**
- * Identifies the resource as a subscription change plan request. Value:
- * subscriptions#seats
- */
+ /// Identifies the resource as a subscription change plan request. Value:
+ /// subscriptions#seats
core.String kind;
- /**
- * Read-only field containing the current number of licensed seats for
- * FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as
- * Google-Vault and Drive-storage.
- */
+
+ /// Read-only field containing the current number of licensed seats for
+ /// FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as
+ /// Google-Vault and Drive-storage.
core.int licensedNumberOfSeats;
- /**
- * The maximumNumberOfSeats property is the maximum number of licenses that
- * the customer can purchase. This property applies to plans other than the
- * annual commitment plan. How a user's licenses are managed depends on the
- * subscription's payment plan:
- * - annual commitment plan (with monthly or yearly payments) — For this plan,
- * a reseller is invoiced on the number of user licenses in the numberOfSeats
- * property. The maximumNumberOfSeats property is a read-only property in the
- * API's response.
- * - flexible plan — For this plan, a reseller is invoiced on the actual
- * number of users which is capped by the maximumNumberOfSeats. This is the
- * maximum number of user licenses a customer has for user license
- * provisioning. This quantity can be increased up to the maximum limit
- * defined in the reseller's contract. And the minimum quantity is the current
- * number of users in the customer account.
- * - 30-day free trial plan — A subscription in a 30-day free trial is
- * restricted to maximum 10 seats.
- */
+
+ /// The maximumNumberOfSeats property is the maximum number of licenses that
+ /// the customer can purchase. This property applies to plans other than the
+ /// annual commitment plan. How a user's licenses are managed depends on the
+ /// subscription's payment plan:
+ /// - annual commitment plan (with monthly or yearly payments) — For this
+ /// plan, a reseller is invoiced on the number of user licenses in the
+ /// numberOfSeats property. The maximumNumberOfSeats property is a read-only
+ /// property in the API's response.
+ /// - flexible plan — For this plan, a reseller is invoiced on the actual
+ /// number of users which is capped by the maximumNumberOfSeats. This is the
+ /// maximum number of user licenses a customer has for user license
+ /// provisioning. This quantity can be increased up to the maximum limit
+ /// defined in the reseller's contract. And the minimum quantity is the
+ /// current number of users in the customer account.
+ /// - 30-day free trial plan — A subscription in a 30-day free trial is
+ /// restricted to maximum 10 seats.
core.int maximumNumberOfSeats;
- /**
- * The numberOfSeats property holds the customer's number of user licenses.
- * How a user's licenses are managed depends on the subscription's plan:
- * - annual commitment plan (with monthly or yearly pay) — For this plan, a
- * reseller is invoiced on the number of user licenses in the numberOfSeats
- * property. This is the maximum number of user licenses that a reseller's
- * customer can create. The reseller can add more licenses, but once set, the
- * numberOfSeats can not be reduced until renewal. The reseller is invoiced
- * based on the numberOfSeats value regardless of how many of these user
- * licenses are provisioned users.
- * - flexible plan — For this plan, a reseller is invoiced on the actual
- * number of users which is capped by the maximumNumberOfSeats. The
- * numberOfSeats property is not used in the request or response for flexible
- * plan customers.
- * - 30-day free trial plan — The numberOfSeats property is not used in the
- * request or response for an account in a 30-day trial.
- */
+
+ /// The numberOfSeats property holds the customer's number of user licenses.
+ /// How a user's licenses are managed depends on the subscription's plan:
+ /// - annual commitment plan (with monthly or yearly pay) — For this plan, a
+ /// reseller is invoiced on the number of user licenses in the numberOfSeats
+ /// property. This is the maximum number of user licenses that a reseller's
+ /// customer can create. The reseller can add more licenses, but once set,
+ /// the numberOfSeats can not be reduced until renewal. The reseller is
+ /// invoiced based on the numberOfSeats value regardless of how many of these
+ /// user licenses are provisioned users.
+ /// - flexible plan — For this plan, a reseller is invoiced on the actual
+ /// number of users which is capped by the maximumNumberOfSeats. The
+ /// numberOfSeats property is not used in the request or response for
+ /// flexible plan customers.
+ /// - 30-day free trial plan — The numberOfSeats property is not used in the
+ /// request or response for an account in a 30-day trial.
core.int numberOfSeats;
Seats();
@@ -1411,7 +1409,8 @@ class Seats {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (kind != null) {
_json["kind"] = kind;
}
@@ -1428,19 +1427,14 @@ class Seats {
}
}
-/**
- * In this version of the API, annual commitment plan's interval is one year.
- */
+/// In this version of the API, annual commitment plan's interval is one year.
class SubscriptionPlanCommitmentInterval {
- /**
- * An annual commitment plan's interval's endTime in milliseconds using the
- * UNIX Epoch format. See an example Epoch converter.
- */
+ /// An annual commitment plan's interval's endTime in milliseconds using the
+ /// UNIX Epoch format. See an example Epoch converter.
core.String endTime;
- /**
- * An annual commitment plan's interval's startTime in milliseconds using UNIX
- * Epoch format. See an example Epoch converter.
- */
+
+ /// An annual commitment plan's interval's startTime in milliseconds using
+ /// UNIX Epoch format. See an example Epoch converter.
core.String startTime;
SubscriptionPlanCommitmentInterval();
@@ -1455,7 +1449,8 @@ class SubscriptionPlanCommitmentInterval {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (endTime != null) {
_json["endTime"] = endTime;
}
@@ -1466,46 +1461,42 @@ class SubscriptionPlanCommitmentInterval {
}
}
-/**
- * The plan property is required. In this version of the API, the G Suite plans
- * are the flexible plan, annual commitment plan, and the 30-day free trial
- * plan. For more information about the API"s payment plans, see the API
- * concepts.
- */
+/// The plan property is required. In this version of the API, the G Suite
+/// plans are the flexible plan, annual commitment plan, and the 30-day free
+/// trial plan. For more information about the API"s payment plans, see the API
+/// concepts.
class SubscriptionPlan {
- /**
- * In this version of the API, annual commitment plan's interval is one year.
- */
+ /// In this version of the API, annual commitment plan's interval is one
+ /// year.
SubscriptionPlanCommitmentInterval commitmentInterval;
- /**
- * The isCommitmentPlan property's boolean value identifies the plan as an
- * annual commitment plan:
- * - true — The subscription's plan is an annual commitment plan.
- * - false — The plan is not an annual commitment plan.
- */
+
+ /// The isCommitmentPlan property's boolean value identifies the plan as an
+ /// annual commitment plan:
+ /// - true — The subscription's plan is an annual commitment plan.
+ /// - false — The plan is not an annual commitment plan.
core.bool isCommitmentPlan;
- /**
- * The planName property is required. This is the name of the subscription's
- * plan. For more information about the Google payment plans, see the API
- * concepts.
- *
- * Possible values are:
- * - ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments
- * - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments
- * - FLEXIBLE — The flexible plan
- * - TRIAL — The 30-day free trial plan. A subscription in trial will be
- * suspended after the 30th free day if no payment plan is assigned. Calling
- * changePlan will assign a payment plan to a trial but will not activate the
- * plan. A trial will automatically begin its assigned payment plan after its
- * 30th free day or immediately after calling startPaidService.
- */
+
+ /// The planName property is required. This is the name of the subscription's
+ /// plan. For more information about the Google payment plans, see the API
+ /// concepts.
+ ///
+ /// Possible values are:
+ /// - ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments
+ /// - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments
+ /// - FLEXIBLE — The flexible plan
+ /// - TRIAL — The 30-day free trial plan. A subscription in trial will be
+ /// suspended after the 30th free day if no payment plan is assigned. Calling
+ /// changePlan will assign a payment plan to a trial but will not activate
+ /// the plan. A trial will automatically begin its assigned payment plan
+ /// after its 30th free day or immediately after calling startPaidService.
core.String planName;
SubscriptionPlan();
SubscriptionPlan.fromJson(core.Map _json) {
if (_json.containsKey("commitmentInterval")) {
- commitmentInterval = new SubscriptionPlanCommitmentInterval.fromJson(_json["commitmentInterval"]);
+ commitmentInterval = new SubscriptionPlanCommitmentInterval.fromJson(
+ _json["commitmentInterval"]);
}
if (_json.containsKey("isCommitmentPlan")) {
isCommitmentPlan = _json["isCommitmentPlan"];
@@ -1516,7 +1507,8 @@ class SubscriptionPlan {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (commitmentInterval != null) {
_json["commitmentInterval"] = (commitmentInterval).toJson();
}
@@ -1530,22 +1522,17 @@ class SubscriptionPlan {
}
}
-/**
- * Read-only transfer related information for the subscription. For more
- * information, see retrieve transferable subscriptions for a customer.
- */
+/// Read-only transfer related information for the subscription. For more
+/// information, see retrieve transferable subscriptions for a customer.
class SubscriptionTransferInfo {
- /**
- * When inserting a subscription, this is the minimum number of seats listed
- * in the transfer order for this product. For example, if the customer has 20
- * users, the reseller cannot place a transfer order of 15 seats. The minimum
- * is 20 seats.
- */
+ /// When inserting a subscription, this is the minimum number of seats listed
+ /// in the transfer order for this product. For example, if the customer has
+ /// 20 users, the reseller cannot place a transfer order of 15 seats. The
+ /// minimum is 20 seats.
core.int minimumTransferableSeats;
- /**
- * The time when transfer token or intent to transfer will expire. The time is
- * in milliseconds using UNIX Epoch format.
- */
+
+ /// The time when transfer token or intent to transfer will expire. The time
+ /// is in milliseconds using UNIX Epoch format.
core.String transferabilityExpirationTime;
SubscriptionTransferInfo();
@@ -1560,7 +1547,8 @@ class SubscriptionTransferInfo {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (minimumTransferableSeats != null) {
_json["minimumTransferableSeats"] = minimumTransferableSeats;
}
@@ -1571,21 +1559,16 @@ class SubscriptionTransferInfo {
}
}
-/**
- * The G Suite annual commitment and flexible payment plans can be in a 30-day
- * free trial. For more information, see the API concepts.
- */
+/// The G Suite annual commitment and flexible payment plans can be in a 30-day
+/// free trial. For more information, see the API concepts.
class SubscriptionTrialSettings {
- /**
- * Determines if a subscription's plan is in a 30-day free trial or not:
- * - true — The plan is in trial.
- * - false — The plan is not in trial.
- */
+ /// Determines if a subscription's plan is in a 30-day free trial or not:
+ /// - true — The plan is in trial.
+ /// - false — The plan is not in trial.
core.bool isInTrial;
- /**
- * Date when the trial ends. The value is in milliseconds using the UNIX Epoch
- * format. See an example Epoch converter.
- */
+
+ /// Date when the trial ends. The value is in milliseconds using the UNIX
+ /// Epoch format. See an example Epoch converter.
core.String trialEndTime;
SubscriptionTrialSettings();
@@ -1600,7 +1583,8 @@ class SubscriptionTrialSettings {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (isInTrial != null) {
_json["isInTrial"] = isInTrial;
}
@@ -1611,116 +1595,103 @@ class SubscriptionTrialSettings {
}
}
-/** JSON template for a subscription. */
+/// JSON template for a subscription.
class Subscription {
- /**
- * Read-only field that returns the current billing method for a subscription.
- */
+ /// Read-only field that returns the current billing method for a
+ /// subscription.
core.String billingMethod;
- /**
- * The creationTime property is the date when subscription was created. It is
- * in milliseconds using the Epoch format. See an example Epoch converter.
- */
+
+ /// The creationTime property is the date when subscription was created. It
+ /// is in milliseconds using the Epoch format. See an example Epoch
+ /// converter.
core.String creationTime;
- /** Primary domain name of the customer */
+
+ /// Primary domain name of the customer
core.String customerDomain;
- /**
- * This property will always be returned in a response as the unique
- * identifier generated by Google. In a request, this property can be either
- * the primary domain or the unique identifier generated by Google.
- */
+
+ /// This property will always be returned in a response as the unique
+ /// identifier generated by Google. In a request, this property can be either
+ /// the primary domain or the unique identifier generated by Google.
core.String customerId;
- /**
- * Google-issued code (100 char max) for discounted pricing on subscription
- * plans. Deal code must be included in insert requests in order to receive
- * discounted rate. This property is optional, regular pricing applies if left
- * empty.
- */
+
+ /// Google-issued code (100 char max) for discounted pricing on subscription
+ /// plans. Deal code must be included in insert requests in order to receive
+ /// discounted rate. This property is optional, regular pricing applies if
+ /// left empty.
core.String dealCode;
- /**
- * Identifies the resource as a Subscription. Value: reseller#subscription
- */
+
+ /// Identifies the resource as a Subscription. Value: reseller#subscription
core.String kind;
- /**
- * The plan property is required. In this version of the API, the G Suite
- * plans are the flexible plan, annual commitment plan, and the 30-day free
- * trial plan. For more information about the API"s payment plans, see the API
- * concepts.
- */
+
+ /// The plan property is required. In this version of the API, the G Suite
+ /// plans are the flexible plan, annual commitment plan, and the 30-day free
+ /// trial plan. For more information about the API"s payment plans, see the
+ /// API concepts.
SubscriptionPlan plan;
- /**
- * This is an optional property. This purchase order (PO) information is for
- * resellers to use for their company tracking usage. If a purchaseOrderId
- * value is given it appears in the API responses and shows up in the invoice.
- * The property accepts up to 80 plain text characters.
- */
+
+ /// This is an optional property. This purchase order (PO) information is for
+ /// resellers to use for their company tracking usage. If a purchaseOrderId
+ /// value is given it appears in the API responses and shows up in the
+ /// invoice. The property accepts up to 80 plain text characters.
core.String purchaseOrderId;
- /**
- * Renewal settings for the annual commitment plan. For more detailed
- * information, see renewal options in the administrator help center.
- */
+
+ /// Renewal settings for the annual commitment plan. For more detailed
+ /// information, see renewal options in the administrator help center.
RenewalSettings renewalSettings;
- /**
- * URL to customer's Subscriptions page in the Admin console. The read-only
- * URL is generated by the API service. This is used if your client
- * application requires the customer to complete a task using the
- * Subscriptions page in the Admin console.
- */
+
+ /// URL to customer's Subscriptions page in the Admin console. The read-only
+ /// URL is generated by the API service. This is used if your client
+ /// application requires the customer to complete a task using the
+ /// Subscriptions page in the Admin console.
core.String resourceUiUrl;
- /**
- * This is a required property. The number and limit of user seat licenses in
- * the plan.
- */
+
+ /// This is a required property. The number and limit of user seat licenses
+ /// in the plan.
Seats seats;
- /**
- * A required property. The skuId is a unique system identifier for a
- * product's SKU assigned to a customer in the subscription. For products and
- * SKUs available in this version of the API, see Product and SKU IDs.
- */
+
+ /// A required property. The skuId is a unique system identifier for a
+ /// product's SKU assigned to a customer in the subscription. For products
+ /// and SKUs available in this version of the API, see Product and SKU IDs.
core.String skuId;
- /**
- * Read-only external display name for a product's SKU assigned to a customer
- * in the subscription. SKU names are subject to change at Google's
- * discretion. For products and SKUs available in this version of the API, see
- * Product and SKU IDs.
- */
+
+ /// Read-only external display name for a product's SKU assigned to a
+ /// customer in the subscription. SKU names are subject to change at Google's
+ /// discretion. For products and SKUs available in this version of the API,
+ /// see Product and SKU IDs.
core.String skuName;
- /** This is an optional property. */
+
+ /// This is an optional property.
core.String status;
- /**
- * The subscriptionId is the subscription identifier and is unique for each
- * customer. This is a required property. Since a subscriptionId changes when
- * a subscription is updated, we recommend not using this ID as a key for
- * persistent data. Use the subscriptionId as described in retrieve all
- * reseller subscriptions.
- */
+
+ /// The subscriptionId is the subscription identifier and is unique for each
+ /// customer. This is a required property. Since a subscriptionId changes
+ /// when a subscription is updated, we recommend not using this ID as a key
+ /// for persistent data. Use the subscriptionId as described in retrieve all
+ /// reseller subscriptions.
core.String subscriptionId;
- /**
- * Read-only field containing an enumerable of all the current suspension
- * reasons for a subscription. It is possible for a subscription to have many
- * concurrent, overlapping suspension reasons. A subscription's STATUS is
- * SUSPENDED until all pending suspensions are removed.
- *
- * Possible options include:
- * - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the
- * G Suite Resold Terms of Services.
- * - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their
- * service was cancelled at the end of their term.
- * - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
- * - TRIAL_ENDED - The customer's trial expired without a plan selected.
- * - OTHER - The customer is suspended for an internal Google reason (e.g.
- * abuse or otherwise).
- */
+
+ /// Read-only field containing an enumerable of all the current suspension
+ /// reasons for a subscription. It is possible for a subscription to have
+ /// many concurrent, overlapping suspension reasons. A subscription's STATUS
+ /// is SUSPENDED until all pending suspensions are removed.
+ ///
+ /// Possible options include:
+ /// - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted
+ /// the G Suite Resold Terms of Services.
+ /// - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their
+ /// service was cancelled at the end of their term.
+ /// - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
+ /// - TRIAL_ENDED - The customer's trial expired without a plan selected.
+ /// - OTHER - The customer is suspended for an internal Google reason (e.g.
+ /// abuse or otherwise).
core.List<core.String> suspensionReasons;
- /**
- * Read-only transfer related information for the subscription. For more
- * information, see retrieve transferable subscriptions for a customer.
- */
+
+ /// Read-only transfer related information for the subscription. For more
+ /// information, see retrieve transferable subscriptions for a customer.
SubscriptionTransferInfo transferInfo;
- /**
- * The G Suite annual commitment and flexible payment plans can be in a 30-day
- * free trial. For more information, see the API concepts.
- */
+
+ /// The G Suite annual commitment and flexible payment plans can be in a
+ /// 30-day free trial. For more information, see the API concepts.
SubscriptionTrialSettings trialSettings;
Subscription();
@@ -1775,15 +1746,18 @@ class Subscription {
suspensionReasons = _json["suspensionReasons"];
}
if (_json.containsKey("transferInfo")) {
- transferInfo = new SubscriptionTransferInfo.fromJson(_json["transferInfo"]);
+ transferInfo =
+ new SubscriptionTransferInfo.fromJson(_json["transferInfo"]);
}
if (_json.containsKey("trialSettings")) {
- trialSettings = new SubscriptionTrialSettings.fromJson(_json["trialSettings"]);
+ trialSettings =
+ new SubscriptionTrialSettings.fromJson(_json["trialSettings"]);
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (billingMethod != null) {
_json["billingMethod"] = billingMethod;
}
@@ -1842,19 +1816,17 @@ class Subscription {
}
}
-/** JSON template for a subscription list. */
+/// JSON template for a subscription list.
class Subscriptions {
- /**
- * Identifies the resource as a collection of subscriptions. Value:
- * reseller#subscriptions
- */
+ /// Identifies the resource as a collection of subscriptions. Value:
+ /// reseller#subscriptions
core.String kind;
- /**
- * The continuation token, used to page through large result sets. Provide
- * this value in a subsequent request to return the next page of results.
- */
+
+ /// The continuation token, used to page through large result sets. Provide
+ /// this value in a subsequent request to return the next page of results.
core.String nextPageToken;
- /** The subscriptions in this page of results. */
+
+ /// The subscriptions in this page of results.
core.List<Subscription> subscriptions;
Subscriptions();
@@ -1867,12 +1839,15 @@ class Subscriptions {
nextPageToken = _json["nextPageToken"];
}
if (_json.containsKey("subscriptions")) {
- subscriptions = _json["subscriptions"].map((value) => new Subscription.fromJson(value)).toList();
+ subscriptions = _json["subscriptions"]
+ .map((value) => new Subscription.fromJson(value))
+ .toList();
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (kind != null) {
_json["kind"] = kind;
}
@@ -1880,7 +1855,8 @@ class Subscriptions {
_json["nextPageToken"] = nextPageToken;
}
if (subscriptions != null) {
- _json["subscriptions"] = subscriptions.map((value) => (value).toJson()).toList();
+ _json["subscriptions"] =
+ subscriptions.map((value) => (value).toJson()).toList();
}
return _json;
}
« no previous file with comments | « generated/googleapis/lib/qpxexpress/v1.dart ('k') | generated/googleapis/lib/runtimeconfig/v1.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698