list method

Future<ListSubscriptionOffersResponse> list(String packageName, String productId, String basePlanId, { int? pageSize, String? pageToken, String? $fields, })

Lists all offers under a given subscription.

Request parameters:

packageName - Required. The parent app (package name) for which the subscriptions should be read.

productId - Required. The parent subscription (ID) for which the offers should be read. May be specified as '-' to read all offers under an app.

basePlanId - Required. The parent base plan (ID) for which the offers should be read. May be specified as '-' to read all offers under a subscription or an app. Must be specified as '-' if product_id is specified as '-'.

pageSize - The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 50 subscriptions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageToken - A page token, received from a previous ListSubscriptionsOffers call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSubscriptionOffers must match the call that provided the page token.

$fields - Selector specifying which fields to include in a partial response.

Completes with a ListSubscriptionOffersResponse.

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.

Implementation

async.Future<ListSubscriptionOffersResponse> list(
  core.String packageName,
  core.String productId,
  core.String basePlanId, {
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'androidpublisher/v3/applications/' +
      commons.escapeVariable('$packageName') +
      '/subscriptions/' +
      commons.escapeVariable('$productId') +
      '/basePlans/' +
      commons.escapeVariable('$basePlanId') +
      '/offers';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return ListSubscriptionOffersResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}