File "MonetizationSubscriptionsBasePlans.php"
Full Path: /home/palsarh/web/palsarh.in/public_html/vendor/google/apiclient-services/src/AndroidPublisher/Resource/MonetizationSubscriptionsBasePlans.php
File size: 8.19 KB
MIME-type: text/x-php
Charset: utf-8
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\AndroidPublisher\Resource;
use Google\Service\AndroidPublisher\ActivateBasePlanRequest;
use Google\Service\AndroidPublisher\BatchMigrateBasePlanPricesRequest;
use Google\Service\AndroidPublisher\BatchMigrateBasePlanPricesResponse;
use Google\Service\AndroidPublisher\BatchUpdateBasePlanStatesRequest;
use Google\Service\AndroidPublisher\BatchUpdateBasePlanStatesResponse;
use Google\Service\AndroidPublisher\DeactivateBasePlanRequest;
use Google\Service\AndroidPublisher\MigrateBasePlanPricesRequest;
use Google\Service\AndroidPublisher\MigrateBasePlanPricesResponse;
use Google\Service\AndroidPublisher\Subscription;
/**
* The "basePlans" collection of methods.
* Typical usage is:
* <code>
* $androidpublisherService = new Google\Service\AndroidPublisher(...);
* $basePlans = $androidpublisherService->monetization_subscriptions_basePlans;
* </code>
*/
class MonetizationSubscriptionsBasePlans extends \Google\Service\Resource
{
/**
* Activates a base plan. Once activated, base plans will be available to new
* subscribers. (basePlans.activate)
*
* @param string $packageName Required. The parent app (package name) of the
* base plan to activate.
* @param string $productId Required. The parent subscription (ID) of the base
* plan to activate.
* @param string $basePlanId Required. The unique base plan ID of the base plan
* to activate.
* @param ActivateBasePlanRequest $postBody
* @param array $optParams Optional parameters.
* @return Subscription
* @throws \Google\Service\Exception
*/
public function activate($packageName, $productId, $basePlanId, ActivateBasePlanRequest $postBody, $optParams = [])
{
$params = ['packageName' => $packageName, 'productId' => $productId, 'basePlanId' => $basePlanId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('activate', [$params], Subscription::class);
}
/**
* Batch variant of the MigrateBasePlanPrices endpoint. Set the latencyTolerance
* field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT
* to achieve maximum update throughput. (basePlans.batchMigratePrices)
*
* @param string $packageName Required. The parent app (package name) for which
* the subscriptions should be created or updated. Must be equal to the
* package_name field on all the Subscription resources.
* @param string $productId Required. The product ID of the parent subscription,
* if all updated offers belong to the same subscription. If this batch update
* spans multiple subscriptions, set this field to "-". Must be set.
* @param BatchMigrateBasePlanPricesRequest $postBody
* @param array $optParams Optional parameters.
* @return BatchMigrateBasePlanPricesResponse
* @throws \Google\Service\Exception
*/
public function batchMigratePrices($packageName, $productId, BatchMigrateBasePlanPricesRequest $postBody, $optParams = [])
{
$params = ['packageName' => $packageName, 'productId' => $productId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('batchMigratePrices', [$params], BatchMigrateBasePlanPricesResponse::class);
}
/**
* Activates or deactivates base plans across one or multiple subscriptions. Set
* the latencyTolerance field on nested requests to
* PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update
* throughput. (basePlans.batchUpdateStates)
*
* @param string $packageName Required. The parent app (package name) of the
* updated base plans.
* @param string $productId Required. The product ID of the parent subscription,
* if all updated base plans belong to the same subscription. If this batch
* update spans multiple subscriptions, set this field to "-". Must be set.
* @param BatchUpdateBasePlanStatesRequest $postBody
* @param array $optParams Optional parameters.
* @return BatchUpdateBasePlanStatesResponse
* @throws \Google\Service\Exception
*/
public function batchUpdateStates($packageName, $productId, BatchUpdateBasePlanStatesRequest $postBody, $optParams = [])
{
$params = ['packageName' => $packageName, 'productId' => $productId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('batchUpdateStates', [$params], BatchUpdateBasePlanStatesResponse::class);
}
/**
* Deactivates a base plan. Once deactivated, the base plan will become
* unavailable to new subscribers, but existing subscribers will maintain their
* subscription (basePlans.deactivate)
*
* @param string $packageName Required. The parent app (package name) of the
* base plan to deactivate.
* @param string $productId Required. The parent subscription (ID) of the base
* plan to deactivate.
* @param string $basePlanId Required. The unique base plan ID of the base plan
* to deactivate.
* @param DeactivateBasePlanRequest $postBody
* @param array $optParams Optional parameters.
* @return Subscription
* @throws \Google\Service\Exception
*/
public function deactivate($packageName, $productId, $basePlanId, DeactivateBasePlanRequest $postBody, $optParams = [])
{
$params = ['packageName' => $packageName, 'productId' => $productId, 'basePlanId' => $basePlanId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('deactivate', [$params], Subscription::class);
}
/**
* Deletes a base plan. Can only be done for draft base plans. This action is
* irreversible. (basePlans.delete)
*
* @param string $packageName Required. The parent app (package name) of the
* base plan to delete.
* @param string $productId Required. The parent subscription (ID) of the base
* plan to delete.
* @param string $basePlanId Required. The unique offer ID of the base plan to
* delete.
* @param array $optParams Optional parameters.
* @throws \Google\Service\Exception
*/
public function delete($packageName, $productId, $basePlanId, $optParams = [])
{
$params = ['packageName' => $packageName, 'productId' => $productId, 'basePlanId' => $basePlanId];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params]);
}
/**
* Migrates subscribers from one or more legacy price cohorts to the current
* price. Requests result in Google Play notifying affected subscribers. Only up
* to 250 simultaneous legacy price cohorts are supported.
* (basePlans.migratePrices)
*
* @param string $packageName Required. Package name of the parent app. Must be
* equal to the package_name field on the Subscription resource.
* @param string $productId Required. The ID of the subscription to update. Must
* be equal to the product_id field on the Subscription resource.
* @param string $basePlanId Required. The unique base plan ID of the base plan
* to update prices on.
* @param MigrateBasePlanPricesRequest $postBody
* @param array $optParams Optional parameters.
* @return MigrateBasePlanPricesResponse
* @throws \Google\Service\Exception
*/
public function migratePrices($packageName, $productId, $basePlanId, MigrateBasePlanPricesRequest $postBody, $optParams = [])
{
$params = ['packageName' => $packageName, 'productId' => $productId, 'basePlanId' => $basePlanId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('migratePrices', [$params], MigrateBasePlanPricesResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(MonetizationSubscriptionsBasePlans::class, 'Google_Service_AndroidPublisher_Resource_MonetizationSubscriptionsBasePlans');