Documentation

Google_Service_Reseller_Resource_Customers extends Google_Service_Resource
in package

The "customers" collection of methods.

Typical usage is: $resellerService = new Google_Service_Reseller(...); $customers = $resellerService->customers;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_Reseller_Customer
Get a customer account. (customers.get)
insert()  : Google_Service_Reseller_Customer
Order a new customer's account. (customers.insert)
patch()  : Google_Service_Reseller_Customer
Patch a customer account's settings via Apiary Patch Orchestration (customers.patch)
update()  : Google_Service_Reseller_Customer
Update a customer account's settings. (customers.update)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

get()

Get a customer account. (customers.get)

public get(string $customerId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Reseller_Customer
Parameters
$customerId : string

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.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Reseller_Customer —

insert()

Order a new customer's account. (customers.insert)

public insert(Google_Service_Reseller_Customer $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Reseller_Customer
Parameters
$postBody : Google_Service_Reseller_Customer
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string 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.

Return values
Google_Service_Reseller_Customer —

patch()

Patch a customer account's settings via Apiary Patch Orchestration (customers.patch)

public patch(string $customerId, Google_Service_Reseller_Customer $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Reseller_Customer
Parameters
$customerId : string

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.

$postBody : Google_Service_Reseller_Customer
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Reseller_Customer —

update()

Update a customer account's settings. (customers.update)

public update(string $customerId, Google_Service_Reseller_Customer $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Reseller_Customer
Parameters
$customerId : string

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.

$postBody : Google_Service_Reseller_Customer
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Reseller_Customer —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results