Developer Documentation
See Release Notes
Long Term Support Release
- Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
- Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
- PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
Differences Between: [Versions 401 and 402] [Versions 401 and 403]
(no description)
| File Size: | 1144 lines (34 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 14 classes
Google_Service_Reseller:: (1 method):
__construct()
Google_Service_Reseller_Customers_Resource:: (4 methods):
get()
insert()
patch()
update()
Google_Service_Reseller_Subscriptions_Resource:: (10 methods):
activate()
changePlan()
changeRenewalSettings()
changeSeats()
delete()
get()
insert()
listSubscriptions()
startPaidService()
suspend()
Google_Service_Reseller_Address:: (20 methods):
setAddressLine1()
getAddressLine1()
setAddressLine2()
getAddressLine2()
setAddressLine3()
getAddressLine3()
setContactName()
getContactName()
setCountryCode()
getCountryCode()
setKind()
getKind()
setLocality()
getLocality()
setOrganizationName()
getOrganizationName()
setPostalCode()
getPostalCode()
setRegion()
getRegion()
Google_Service_Reseller_ChangePlanRequest:: (8 methods):
setKind()
getKind()
setPlanName()
getPlanName()
setPurchaseOrderId()
getPurchaseOrderId()
setSeats()
getSeats()
Google_Service_Reseller_Customer:: (16 methods):
setAlternateEmail()
getAlternateEmail()
setCustomerDomain()
getCustomerDomain()
setCustomerDomainVerified()
getCustomerDomainVerified()
setCustomerId()
getCustomerId()
setKind()
getKind()
setPhoneNumber()
getPhoneNumber()
setPostalAddress()
getPostalAddress()
setResourceUiUrl()
getResourceUiUrl()
Google_Service_Reseller_RenewalSettings:: (4 methods):
setKind()
getKind()
setRenewalType()
getRenewalType()
Google_Service_Reseller_Seats:: (8 methods):
setKind()
getKind()
setLicensedNumberOfSeats()
getLicensedNumberOfSeats()
setMaximumNumberOfSeats()
getMaximumNumberOfSeats()
setNumberOfSeats()
getNumberOfSeats()
Google_Service_Reseller_Subscription:: (30 methods):
setBillingMethod()
getBillingMethod()
setCreationTime()
getCreationTime()
setCustomerId()
getCustomerId()
setKind()
getKind()
setPlan()
getPlan()
setPurchaseOrderId()
getPurchaseOrderId()
setRenewalSettings()
getRenewalSettings()
setResourceUiUrl()
getResourceUiUrl()
setSeats()
getSeats()
setSkuId()
getSkuId()
setStatus()
getStatus()
setSubscriptionId()
getSubscriptionId()
setSuspensionReasons()
getSuspensionReasons()
setTransferInfo()
getTransferInfo()
setTrialSettings()
getTrialSettings()
Google_Service_Reseller_SubscriptionPlan:: (6 methods):
setCommitmentInterval()
getCommitmentInterval()
setIsCommitmentPlan()
getIsCommitmentPlan()
setPlanName()
getPlanName()
Google_Service_Reseller_SubscriptionPlanCommitmentInterval:: (4 methods):
setEndTime()
getEndTime()
setStartTime()
getStartTime()
Google_Service_Reseller_SubscriptionTransferInfo:: (4 methods):
setMinimumTransferableSeats()
getMinimumTransferableSeats()
setTransferabilityExpirationTime()
getTransferabilityExpirationTime()
Google_Service_Reseller_SubscriptionTrialSettings:: (4 methods):
setIsInTrial()
getIsInTrial()
setTrialEndTime()
getTrialEndTime()
Google_Service_Reseller_Subscriptions:: (6 methods):
setKind()
getKind()
setNextPageToken()
getNextPageToken()
setSubscriptions()
getSubscriptions()
Class: Google_Service_Reseller - X-Ref
Service definition for Reseller (v1).<p>
Lets you create and manage your customers and their subscriptions.</p>
<p>
For more information about this service, see the API
<a href="https://developers.google.com/google-apps/reseller/" target="_blank">Documentation</a>
</p>
| __construct(Google_Client $client) X-Ref |
| Constructs the internal representation of the Reseller service. param: Google_Client $client |
Class: Google_Service_Reseller_Customers_Resource - X-Ref
The "customers" collection of methods.Typical usage is:
<code>
$resellerService = new Google_Service_Reseller(...);
$customers = $resellerService->customers;
</code>
| get($customerId, $optParams = array() X-Ref |
| Gets a customer resource if one exists and is owned by the reseller. (customers.get) param: string $customerId Id of the Customer param: array $optParams Optional parameters. return: Google_Service_Reseller_Customer |
| insert(Google_Service_Reseller_Customer $postBody, $optParams = array() X-Ref |
| Creates a customer resource if one does not already exist. (customers.insert) param: Google_Customer $postBody param: array $optParams Optional parameters. return: Google_Service_Reseller_Customer |
| patch($customerId, Google_Service_Reseller_Customer $postBody, $optParams = array() X-Ref |
| Update a customer resource if one it exists and is owned by the reseller. This method supports patch semantics. (customers.patch) param: string $customerId Id of the Customer param: Google_Customer $postBody param: array $optParams Optional parameters. return: Google_Service_Reseller_Customer |
| update($customerId, Google_Service_Reseller_Customer $postBody, $optParams = array() X-Ref |
| Update a customer resource if one it exists and is owned by the reseller. (customers.update) param: string $customerId Id of the Customer param: Google_Customer $postBody param: array $optParams Optional parameters. return: Google_Service_Reseller_Customer |
Class: Google_Service_Reseller_Subscriptions_Resource - X-Ref
The "subscriptions" collection of methods.Typical usage is:
<code>
$resellerService = new Google_Service_Reseller(...);
$subscriptions = $resellerService->subscriptions;
</code>
| activate($customerId, $subscriptionId, $optParams = array() X-Ref |
| Activates a subscription previously suspended by the reseller (subscriptions.activate) param: string $customerId Id of the Customer param: string $subscriptionId Id of the subscription, which is unique for a param: array $optParams Optional parameters. return: Google_Service_Reseller_Subscription |
| changePlan($customerId, $subscriptionId, Google_Service_Reseller_ChangePlanRequest $postBody, $optParams = array() X-Ref |
| Changes the plan of a subscription (subscriptions.changePlan) param: string $customerId Id of the Customer param: string $subscriptionId Id of the subscription, which is unique for a param: Google_ChangePlanRequest $postBody param: array $optParams Optional parameters. return: Google_Service_Reseller_Subscription |
| changeRenewalSettings($customerId, $subscriptionId, Google_Service_Reseller_RenewalSettings $postBody, $optParams = array() X-Ref |
| Changes the renewal settings of a subscription (subscriptions.changeRenewalSettings) param: string $customerId Id of the Customer param: string $subscriptionId Id of the subscription, which is unique for a param: Google_RenewalSettings $postBody param: array $optParams Optional parameters. return: Google_Service_Reseller_Subscription |
| changeSeats($customerId, $subscriptionId, Google_Service_Reseller_Seats $postBody, $optParams = array() X-Ref |
| Changes the seats configuration of a subscription (subscriptions.changeSeats) param: string $customerId Id of the Customer param: string $subscriptionId Id of the subscription, which is unique for a param: Google_Seats $postBody param: array $optParams Optional parameters. return: Google_Service_Reseller_Subscription |
| delete($customerId, $subscriptionId, $deletionType, $optParams = array() X-Ref |
| Cancels/Downgrades a subscription. (subscriptions.delete) param: string $customerId Id of the Customer param: string $subscriptionId Id of the subscription, which is unique for a param: string $deletionType Whether the subscription is to be fully cancelled param: array $optParams Optional parameters. |
| get($customerId, $subscriptionId, $optParams = array() X-Ref |
| Gets a subscription of the customer. (subscriptions.get) param: string $customerId Id of the Customer param: string $subscriptionId Id of the subscription, which is unique for a param: array $optParams Optional parameters. return: Google_Service_Reseller_Subscription |
| insert($customerId, Google_Service_Reseller_Subscription $postBody, $optParams = array() X-Ref |
| Creates/Transfers a subscription for the customer. (subscriptions.insert) param: string $customerId Id of the Customer param: Google_Subscription $postBody param: array $optParams Optional parameters. return: Google_Service_Reseller_Subscription |
| listSubscriptions($optParams = array() X-Ref |
| Lists subscriptions of a reseller, optionally filtered by a customer name prefix. (subscriptions.listSubscriptions) param: array $optParams Optional parameters. return: Google_Service_Reseller_Subscriptions |
| startPaidService($customerId, $subscriptionId, $optParams = array() X-Ref |
| Starts paid service of a trial subscription (subscriptions.startPaidService) param: string $customerId Id of the Customer param: string $subscriptionId Id of the subscription, which is unique for a param: array $optParams Optional parameters. return: Google_Service_Reseller_Subscription |
| suspend($customerId, $subscriptionId, $optParams = array() X-Ref |
| Suspends an active subscription (subscriptions.suspend) param: string $customerId Id of the Customer param: string $subscriptionId Id of the subscription, which is unique for a param: array $optParams Optional parameters. return: Google_Service_Reseller_Subscription |
Class: Google_Service_Reseller_Address - X-Ref
| setAddressLine1($addressLine1) X-Ref |
| No description |
| getAddressLine1() X-Ref |
| No description |
| setAddressLine2($addressLine2) X-Ref |
| No description |
| getAddressLine2() X-Ref |
| No description |
| setAddressLine3($addressLine3) X-Ref |
| No description |
| getAddressLine3() X-Ref |
| No description |
| setContactName($contactName) X-Ref |
| No description |
| getContactName() X-Ref |
| No description |
| setCountryCode($countryCode) X-Ref |
| No description |
| getCountryCode() X-Ref |
| No description |
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
| setLocality($locality) X-Ref |
| No description |
| getLocality() X-Ref |
| No description |
| setOrganizationName($organizationName) X-Ref |
| No description |
| getOrganizationName() X-Ref |
| No description |
| setPostalCode($postalCode) X-Ref |
| No description |
| getPostalCode() X-Ref |
| No description |
| setRegion($region) X-Ref |
| No description |
| getRegion() X-Ref |
| No description |
Class: Google_Service_Reseller_ChangePlanRequest - X-Ref
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
| setPlanName($planName) X-Ref |
| No description |
| getPlanName() X-Ref |
| No description |
| setPurchaseOrderId($purchaseOrderId) X-Ref |
| No description |
| getPurchaseOrderId() X-Ref |
| No description |
| setSeats(Google_Service_Reseller_Seats $seats) X-Ref |
| No description |
| getSeats() X-Ref |
| No description |
Class: Google_Service_Reseller_Customer - X-Ref
| setAlternateEmail($alternateEmail) X-Ref |
| No description |
| getAlternateEmail() X-Ref |
| No description |
| setCustomerDomain($customerDomain) X-Ref |
| No description |
| getCustomerDomain() X-Ref |
| No description |
| setCustomerDomainVerified($customerDomainVerified) X-Ref |
| No description |
| getCustomerDomainVerified() X-Ref |
| No description |
| setCustomerId($customerId) X-Ref |
| No description |
| getCustomerId() X-Ref |
| No description |
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
| setPhoneNumber($phoneNumber) X-Ref |
| No description |
| getPhoneNumber() X-Ref |
| No description |
| setPostalAddress(Google_Service_Reseller_Address $postalAddress) X-Ref |
| No description |
| getPostalAddress() X-Ref |
| No description |
| setResourceUiUrl($resourceUiUrl) X-Ref |
| No description |
| getResourceUiUrl() X-Ref |
| No description |
Class: Google_Service_Reseller_RenewalSettings - X-Ref
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
| setRenewalType($renewalType) X-Ref |
| No description |
| getRenewalType() X-Ref |
| No description |
Class: Google_Service_Reseller_Seats - X-Ref
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
| setLicensedNumberOfSeats($licensedNumberOfSeats) X-Ref |
| No description |
| getLicensedNumberOfSeats() X-Ref |
| No description |
| setMaximumNumberOfSeats($maximumNumberOfSeats) X-Ref |
| No description |
| getMaximumNumberOfSeats() X-Ref |
| No description |
| setNumberOfSeats($numberOfSeats) X-Ref |
| No description |
| getNumberOfSeats() X-Ref |
| No description |
Class: Google_Service_Reseller_Subscription - X-Ref
| setBillingMethod($billingMethod) X-Ref |
| No description |
| getBillingMethod() X-Ref |
| No description |
| setCreationTime($creationTime) X-Ref |
| No description |
| getCreationTime() X-Ref |
| No description |
| setCustomerId($customerId) X-Ref |
| No description |
| getCustomerId() X-Ref |
| No description |
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
| setPlan(Google_Service_Reseller_SubscriptionPlan $plan) X-Ref |
| No description |
| getPlan() X-Ref |
| No description |
| setPurchaseOrderId($purchaseOrderId) X-Ref |
| No description |
| getPurchaseOrderId() X-Ref |
| No description |
| setRenewalSettings(Google_Service_Reseller_RenewalSettings $renewalSettings) X-Ref |
| No description |
| getRenewalSettings() X-Ref |
| No description |
| setResourceUiUrl($resourceUiUrl) X-Ref |
| No description |
| getResourceUiUrl() X-Ref |
| No description |
| setSeats(Google_Service_Reseller_Seats $seats) X-Ref |
| No description |
| getSeats() X-Ref |
| No description |
| setSkuId($skuId) X-Ref |
| No description |
| getSkuId() X-Ref |
| No description |
| setStatus($status) X-Ref |
| No description |
| getStatus() X-Ref |
| No description |
| setSubscriptionId($subscriptionId) X-Ref |
| No description |
| getSubscriptionId() X-Ref |
| No description |
| setSuspensionReasons($suspensionReasons) X-Ref |
| No description |
| getSuspensionReasons() X-Ref |
| No description |
| setTransferInfo(Google_Service_Reseller_SubscriptionTransferInfo $transferInfo) X-Ref |
| No description |
| getTransferInfo() X-Ref |
| No description |
| setTrialSettings(Google_Service_Reseller_SubscriptionTrialSettings $trialSettings) X-Ref |
| No description |
| getTrialSettings() X-Ref |
| No description |
Class: Google_Service_Reseller_SubscriptionPlan - X-Ref
| setCommitmentInterval(Google_Service_Reseller_SubscriptionPlanCommitmentInterval $commitmentInterval) X-Ref |
| No description |
| getCommitmentInterval() X-Ref |
| No description |
| setIsCommitmentPlan($isCommitmentPlan) X-Ref |
| No description |
| getIsCommitmentPlan() X-Ref |
| No description |
| setPlanName($planName) X-Ref |
| No description |
| getPlanName() X-Ref |
| No description |
Class: Google_Service_Reseller_SubscriptionPlanCommitmentInterval - X-Ref
| setEndTime($endTime) X-Ref |
| No description |
| getEndTime() X-Ref |
| No description |
| setStartTime($startTime) X-Ref |
| No description |
| getStartTime() X-Ref |
| No description |
Class: Google_Service_Reseller_SubscriptionTransferInfo - X-Ref
| setMinimumTransferableSeats($minimumTransferableSeats) X-Ref |
| No description |
| getMinimumTransferableSeats() X-Ref |
| No description |
| setTransferabilityExpirationTime($transferabilityExpirationTime) X-Ref |
| No description |
| getTransferabilityExpirationTime() X-Ref |
| No description |
Class: Google_Service_Reseller_SubscriptionTrialSettings - X-Ref
| setIsInTrial($isInTrial) X-Ref |
| No description |
| getIsInTrial() X-Ref |
| No description |
| setTrialEndTime($trialEndTime) X-Ref |
| No description |
| getTrialEndTime() X-Ref |
| No description |
Class: Google_Service_Reseller_Subscriptions - X-Ref
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
| setNextPageToken($nextPageToken) X-Ref |
| No description |
| getNextPageToken() X-Ref |
| No description |
| setSubscriptions($subscriptions) X-Ref |
| No description |
| getSubscriptions() X-Ref |
| No description |
