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
18namespace Google\Service\DataTransfer\Resource;
19
20use Google\Service\DataTransfer\DataTransfer;
21use Google\Service\DataTransfer\DataTransfersListResponse;
22
23/**
24 * The "transfers" collection of methods.
25 * Typical usage is:
26 *  <code>
27 *   $adminService = new Google\Service\DataTransfer(...);
28 *   $transfers = $adminService->transfers;
29 *  </code>
30 */
31class Transfers extends \Google\Service\Resource
32{
33  /**
34   * Retrieves a data transfer request by its resource ID. (transfers.get)
35   *
36   * @param string $dataTransferId ID of the resource to be retrieved. This is
37   * returned in the response from the insert method.
38   * @param array $optParams Optional parameters.
39   * @return DataTransfer
40   */
41  public function get($dataTransferId, $optParams = [])
42  {
43    $params = ['dataTransferId' => $dataTransferId];
44    $params = array_merge($params, $optParams);
45    return $this->call('get', [$params], DataTransfer::class);
46  }
47  /**
48   * Inserts a data transfer request. (transfers.insert)
49   *
50   * @param DataTransfer $postBody
51   * @param array $optParams Optional parameters.
52   * @return DataTransfer
53   */
54  public function insert(DataTransfer $postBody, $optParams = [])
55  {
56    $params = ['postBody' => $postBody];
57    $params = array_merge($params, $optParams);
58    return $this->call('insert', [$params], DataTransfer::class);
59  }
60  /**
61   * Lists the transfers for a customer by source user, destination user, or
62   * status. (transfers.listTransfers)
63   *
64   * @param array $optParams Optional parameters.
65   *
66   * @opt_param string customerId Immutable ID of the Google Workspace account.
67   * @opt_param int maxResults Maximum number of results to return. Default is
68   * 100.
69   * @opt_param string newOwnerUserId Destination user's profile ID.
70   * @opt_param string oldOwnerUserId Source user's profile ID.
71   * @opt_param string pageToken Token to specify the next page in the list.
72   * @opt_param string status Status of the transfer.
73   * @return DataTransfersListResponse
74   */
75  public function listTransfers($optParams = [])
76  {
77    $params = [];
78    $params = array_merge($params, $optParams);
79    return $this->call('list', [$params], DataTransfersListResponse::class);
80  }
81}
82
83// Adding a class alias for backwards compatibility with the previous class name.
84class_alias(Transfers::class, 'Google_Service_DataTransfer_Resource_Transfers');
85