extend method

Future<ExtendSubscriptionResponse> extend(
  1. ExtendSubscriptionRequest request,
  2. String name, {
  3. String? $fields,
})

[Opt-in only] Most partners should be on auto-extend by default.

Extends a subscription service for their customers on an ongoing basis for the subscription to remain active and renewable. It should be called directly by the partner using service accounts.

request - The metadata request object.

Request parameters:

name - Required. The name of the subscription resource to be extended. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}". Value must have pattern ^partners/\[^/\]+/subscriptions/\[^/\]+$.

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

Completes with a ExtendSubscriptionResponse.

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<ExtendSubscriptionResponse> extend(
  ExtendSubscriptionRequest request,
  core.String name, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$name') + ':extend';

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