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\Apigee\Resource;
19
20use Google\Service\Apigee\GoogleCloudApigeeV1App;
21use Google\Service\Apigee\GoogleCloudApigeeV1ListAppsResponse;
22
23/**
24 * The "apps" collection of methods.
25 * Typical usage is:
26 *  <code>
27 *   $apigeeService = new Google\Service\Apigee(...);
28 *   $apps = $apigeeService->apps;
29 *  </code>
30 */
31class OrganizationsApps extends \Google\Service\Resource
32{
33  /**
34   * Gets the app profile for the specified app ID. (apps.get)
35   *
36   * @param string $name Required. App ID in the following format:
37   * `organizations/{org}/apps/{app}`
38   * @param array $optParams Optional parameters.
39   * @return GoogleCloudApigeeV1App
40   */
41  public function get($name, $optParams = [])
42  {
43    $params = ['name' => $name];
44    $params = array_merge($params, $optParams);
45    return $this->call('get', [$params], GoogleCloudApigeeV1App::class);
46  }
47  /**
48   * Lists IDs of apps within an organization that have the specified app status
49   * (approved or revoked) or are of the specified app type (developer or
50   * company). (apps.listOrganizationsApps)
51   *
52   * @param string $parent Required. Resource path of the parent in the following
53   * format: `organizations/{org}`
54   * @param array $optParams Optional parameters.
55   *
56   * @opt_param string apiProduct API product.
57   * @opt_param string apptype Optional. Filter by the type of the app. Valid
58   * values are `company` or `developer`. Defaults to `developer`.
59   * @opt_param bool expand Optional. Flag that specifies whether to return an
60   * expanded list of apps for the organization. Defaults to `false`.
61   * @opt_param string ids Optional. Comma-separated list of app IDs on which to
62   * filter.
63   * @opt_param bool includeCred Optional. Flag that specifies whether to include
64   * credentials in the response.
65   * @opt_param string keyStatus Optional. Key status of the app. Valid values
66   * include `approved` or `revoked`. Defaults to `approved`.
67   * @opt_param string rows Optional. Maximum number of app IDs to return.
68   * Defaults to 10000.
69   * @opt_param string startKey Returns the list of apps starting from the
70   * specified app ID.
71   * @opt_param string status Optional. Filter by the status of the app. Valid
72   * values are `approved` or `revoked`. Defaults to `approved`.
73   * @return GoogleCloudApigeeV1ListAppsResponse
74   */
75  public function listOrganizationsApps($parent, $optParams = [])
76  {
77    $params = ['parent' => $parent];
78    $params = array_merge($params, $optParams);
79    return $this->call('list', [$params], GoogleCloudApigeeV1ListAppsResponse::class);
80  }
81}
82
83// Adding a class alias for backwards compatibility with the previous class name.
84class_alias(OrganizationsApps::class, 'Google_Service_Apigee_Resource_OrganizationsApps');
85