Viewing file:  Orgunits.php (6.38 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?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\Directory\Resource;
use Google\Service\Directory\OrgUnit;
use Google\Service\Directory\OrgUnits as OrgUnitsModel;
/**
* The "orgunits" collection of methods.
* Typical usage is:
* <code>
* $adminService = new Google\Service\Directory(...);
* $orgunits = $adminService->orgunits;
* </code>
*/
class Orgunits extends \Google\Service\Resource
{
/**
* Removes an organizational unit. (orgunits.delete)
*
* @param string $customerId The unique ID for the customer's Google Workspace
* account. As an account administrator, you can also use the `my_customer`
* alias to represent your account's `customerId`. The `customerId` is also
* returned as part of the [Users resource](/admin-
* sdk/directory/v1/reference/users).
* @param string $orgUnitPath The full path of the organizational unit (minus
* the leading `/`) or its unique ID.
* @param array $optParams Optional parameters.
*/
public function delete($customerId, $orgUnitPath, $optParams = [])
{
$params = ['customerId' => $customerId, 'orgUnitPath' => $orgUnitPath];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params]);
}
/**
* Retrieves an organizational unit. (orgunits.get)
*
* @param string $customerId The unique ID for the customer's Google Workspace
* account. As an account administrator, you can also use the `my_customer`
* alias to represent your account's `customerId`. The `customerId` is also
* returned as part of the [Users resource](/admin-
* sdk/directory/v1/reference/users).
* @param string $orgUnitPath The full path of the organizational unit (minus
* the leading `/`) or its unique ID.
* @param array $optParams Optional parameters.
* @return OrgUnit
*/
public function get($customerId, $orgUnitPath, $optParams = [])
{
$params = ['customerId' => $customerId, 'orgUnitPath' => $orgUnitPath];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], OrgUnit::class);
}
/**
* Adds an organizational unit. (orgunits.insert)
*
* @param string $customerId The unique ID for the customer's Google Workspace
* account. As an account administrator, you can also use the `my_customer`
* alias to represent your account's `customerId`. The `customerId` is also
* returned as part of the [Users resource](/admin-
* sdk/directory/v1/reference/users).
* @param OrgUnit $postBody
* @param array $optParams Optional parameters.
* @return OrgUnit
*/
public function insert($customerId, OrgUnit $postBody, $optParams = [])
{
$params = ['customerId' => $customerId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('insert', [$params], OrgUnit::class);
}
/**
* Retrieves a list of all organizational units for an account.
* (orgunits.listOrgunits)
*
* @param string $customerId The unique ID for the customer's Google Workspace
* account. As an account administrator, you can also use the `my_customer`
* alias to represent your account's `customerId`. The `customerId` is also
* returned as part of the [Users resource](/admin-
* sdk/directory/v1/reference/users).
* @param array $optParams Optional parameters.
*
* @opt_param string orgUnitPath The full path to the organizational unit or its
* unique ID. Returns the children of the specified organizational unit.
* @opt_param string type Whether to return all sub-organizations or just
* immediate children.
* @return OrgUnitsModel
*/
public function listOrgunits($customerId, $optParams = [])
{
$params = ['customerId' => $customerId];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], OrgUnitsModel::class);
}
/**
* Updates an organizational unit. This method supports [patch semantics
* ](/admin-sdk/directory/v1/guides/performance#patch) (orgunits.patch)
*
* @param string $customerId The unique ID for the customer's Google Workspace
* account. As an account administrator, you can also use the `my_customer`
* alias to represent your account's `customerId`. The `customerId` is also
* returned as part of the [Users resource](/admin-
* sdk/directory/v1/reference/users).
* @param string $orgUnitPath The full path of the organizational unit (minus
* the leading `/`) or its unique ID.
* @param OrgUnit $postBody
* @param array $optParams Optional parameters.
* @return OrgUnit
*/
public function patch($customerId, $orgUnitPath, OrgUnit $postBody, $optParams = [])
{
$params = ['customerId' => $customerId, 'orgUnitPath' => $orgUnitPath, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], OrgUnit::class);
}
/**
* Updates an organizational unit. (orgunits.update)
*
* @param string $customerId The unique ID for the customer's Google Workspace
* account. As an account administrator, you can also use the `my_customer`
* alias to represent your account's `customerId`. The `customerId` is also
* returned as part of the [Users resource](/admin-
* sdk/directory/v1/reference/users).
* @param string $orgUnitPath The full path of the organizational unit (minus
* the leading `/`) or its unique ID.
* @param OrgUnit $postBody
* @param array $optParams Optional parameters.
* @return OrgUnit
*/
public function update($customerId, $orgUnitPath, OrgUnit $postBody, $optParams = [])
{
$params = ['customerId' => $customerId, 'orgUnitPath' => $orgUnitPath, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('update', [$params], OrgUnit::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Orgunits::class, 'Google_Service_Directory_Resource_Orgunits');
|