1 | <?php
|
---|
2 | /*
|
---|
3 | * Copyright 2014 Google Inc.
|
---|
4 | *
|
---|
5 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not
|
---|
6 | * use this file except in compliance with the License. You may obtain a copy of
|
---|
7 | * the License at
|
---|
8 | *
|
---|
9 | * http://www.apache.org/licenses/LICENSE-2.0
|
---|
10 | *
|
---|
11 | * Unless required by applicable law or agreed to in writing, software
|
---|
12 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
---|
13 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
---|
14 | * License for the specific language governing permissions and limitations under
|
---|
15 | * the License.
|
---|
16 | */
|
---|
17 |
|
---|
18 | namespace Google\Service\Directory\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\Directory\Domains as DomainsModel;
|
---|
21 | use Google\Service\Directory\Domains2;
|
---|
22 |
|
---|
23 | /**
|
---|
24 | * The "domains" collection of methods.
|
---|
25 | * Typical usage is:
|
---|
26 | * <code>
|
---|
27 | * $adminService = new Google\Service\Directory(...);
|
---|
28 | * $domains = $adminService->domains;
|
---|
29 | * </code>
|
---|
30 | */
|
---|
31 | class Domains extends \Google\Service\Resource
|
---|
32 | {
|
---|
33 | /**
|
---|
34 | * Deletes a domain of the customer. (domains.delete)
|
---|
35 | *
|
---|
36 | * @param string $customer Immutable ID of the Google Workspace account.
|
---|
37 | * @param string $domainName Name of domain to be deleted
|
---|
38 | * @param array $optParams Optional parameters.
|
---|
39 | * @throws \Google\Service\Exception
|
---|
40 | */
|
---|
41 | public function delete($customer, $domainName, $optParams = [])
|
---|
42 | {
|
---|
43 | $params = ['customer' => $customer, 'domainName' => $domainName];
|
---|
44 | $params = array_merge($params, $optParams);
|
---|
45 | return $this->call('delete', [$params]);
|
---|
46 | }
|
---|
47 | /**
|
---|
48 | * Retrieves a domain of the customer. (domains.get)
|
---|
49 | *
|
---|
50 | * @param string $customer The unique ID for the customer's Google Workspace
|
---|
51 | * account. In case of a multi-domain account, to fetch all groups for a
|
---|
52 | * customer, use this field instead of `domain`. You can also use the
|
---|
53 | * `my_customer` alias to represent your account's `customerId`. The
|
---|
54 | * `customerId` is also returned as part of the [Users](/admin-
|
---|
55 | * sdk/directory/v1/reference/users) resource. You must provide either the
|
---|
56 | * `customer` or the `domain` parameter.
|
---|
57 | * @param string $domainName Name of domain to be retrieved
|
---|
58 | * @param array $optParams Optional parameters.
|
---|
59 | * @return DomainsModel
|
---|
60 | * @throws \Google\Service\Exception
|
---|
61 | */
|
---|
62 | public function get($customer, $domainName, $optParams = [])
|
---|
63 | {
|
---|
64 | $params = ['customer' => $customer, 'domainName' => $domainName];
|
---|
65 | $params = array_merge($params, $optParams);
|
---|
66 | return $this->call('get', [$params], DomainsModel::class);
|
---|
67 | }
|
---|
68 | /**
|
---|
69 | * Inserts a domain of the customer. (domains.insert)
|
---|
70 | *
|
---|
71 | * @param string $customer Immutable ID of the Google Workspace account.
|
---|
72 | * @param DomainsModel $postBody
|
---|
73 | * @param array $optParams Optional parameters.
|
---|
74 | * @return DomainsModel
|
---|
75 | * @throws \Google\Service\Exception
|
---|
76 | */
|
---|
77 | public function insert($customer, DomainsModel $postBody, $optParams = [])
|
---|
78 | {
|
---|
79 | $params = ['customer' => $customer, 'postBody' => $postBody];
|
---|
80 | $params = array_merge($params, $optParams);
|
---|
81 | return $this->call('insert', [$params], DomainsModel::class);
|
---|
82 | }
|
---|
83 | /**
|
---|
84 | * Lists the domains of the customer. (domains.listDomains)
|
---|
85 | *
|
---|
86 | * @param string $customer The unique ID for the customer's Google Workspace
|
---|
87 | * account. In case of a multi-domain account, to fetch all groups for a
|
---|
88 | * customer, use this field instead of `domain`. You can also use the
|
---|
89 | * `my_customer` alias to represent your account's `customerId`. The
|
---|
90 | * `customerId` is also returned as part of the [Users](/admin-
|
---|
91 | * sdk/directory/v1/reference/users) resource. You must provide either the
|
---|
92 | * `customer` or the `domain` parameter.
|
---|
93 | * @param array $optParams Optional parameters.
|
---|
94 | * @return Domains2
|
---|
95 | * @throws \Google\Service\Exception
|
---|
96 | */
|
---|
97 | public function listDomains($customer, $optParams = [])
|
---|
98 | {
|
---|
99 | $params = ['customer' => $customer];
|
---|
100 | $params = array_merge($params, $optParams);
|
---|
101 | return $this->call('list', [$params], Domains2::class);
|
---|
102 | }
|
---|
103 | }
|
---|
104 |
|
---|
105 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
106 | class_alias(Domains::class, 'Google_Service_Directory_Resource_Domains');
|
---|