[e3d4e0a] | 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\Apigee\Resource;
|
---|
| 19 |
|
---|
| 20 | use Google\Service\Apigee\GoogleCloudApigeeV1App;
|
---|
| 21 | use 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->organizations_apps;
|
---|
| 29 | * </code>
|
---|
| 30 | */
|
---|
| 31 | class 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 | * @throws \Google\Service\Exception
|
---|
| 41 | */
|
---|
| 42 | public function get($name, $optParams = [])
|
---|
| 43 | {
|
---|
| 44 | $params = ['name' => $name];
|
---|
| 45 | $params = array_merge($params, $optParams);
|
---|
| 46 | return $this->call('get', [$params], GoogleCloudApigeeV1App::class);
|
---|
| 47 | }
|
---|
| 48 | /**
|
---|
| 49 | * Lists IDs of apps within an organization that have the specified app status
|
---|
| 50 | * (approved or revoked) or are of the specified app type (developer or
|
---|
| 51 | * company). (apps.listOrganizationsApps)
|
---|
| 52 | *
|
---|
| 53 | * @param string $parent Required. Resource path of the parent in the following
|
---|
| 54 | * format: `organizations/{org}`
|
---|
| 55 | * @param array $optParams Optional parameters.
|
---|
| 56 | *
|
---|
| 57 | * @opt_param string apiProduct API product.
|
---|
| 58 | * @opt_param string apptype Optional. 'apptype' is no longer available. Use a
|
---|
| 59 | * 'filter' instead.
|
---|
| 60 | * @opt_param bool expand Optional. Flag that specifies whether to return an
|
---|
| 61 | * expanded list of apps for the organization. Defaults to `false`.
|
---|
| 62 | * @opt_param string filter Optional. The filter expression to be used to get
|
---|
| 63 | * the list of apps, where filtering can be done on developerEmail, apiProduct,
|
---|
| 64 | * consumerKey, status, appId, appName, appType and appGroup. Examples:
|
---|
| 65 | * "developerEmail=foo@bar.com", "appType=AppGroup", or "appType=Developer"
|
---|
| 66 | * "filter" is supported from ver 1.10.0 and above.
|
---|
| 67 | * @opt_param string ids Optional. Comma-separated list of app IDs on which to
|
---|
| 68 | * filter.
|
---|
| 69 | * @opt_param bool includeCred Optional. Flag that specifies whether to include
|
---|
| 70 | * credentials in the response.
|
---|
| 71 | * @opt_param string keyStatus Optional. Key status of the app. Valid values
|
---|
| 72 | * include `approved` or `revoked`. Defaults to `approved`.
|
---|
| 73 | * @opt_param int pageSize Optional. Count of apps a single page can have in the
|
---|
| 74 | * response. If unspecified, at most 100 apps will be returned. The maximum
|
---|
| 75 | * value is 100; values above 100 will be coerced to 100. "page_size" is
|
---|
| 76 | * supported from ver 1.10.0 and above.
|
---|
| 77 | * @opt_param string pageToken Optional. The starting index record for listing
|
---|
| 78 | * the developers. "page_token" is supported from ver 1.10.0 and above.
|
---|
| 79 | * @opt_param string rows Optional. Maximum number of app IDs to return.
|
---|
| 80 | * Defaults to 10000.
|
---|
| 81 | * @opt_param string startKey Returns the list of apps starting from the
|
---|
| 82 | * specified app ID.
|
---|
| 83 | * @opt_param string status Optional. Filter by the status of the app. Valid
|
---|
| 84 | * values are `approved` or `revoked`. Defaults to `approved`.
|
---|
| 85 | * @return GoogleCloudApigeeV1ListAppsResponse
|
---|
| 86 | * @throws \Google\Service\Exception
|
---|
| 87 | */
|
---|
| 88 | public function listOrganizationsApps($parent, $optParams = [])
|
---|
| 89 | {
|
---|
| 90 | $params = ['parent' => $parent];
|
---|
| 91 | $params = array_merge($params, $optParams);
|
---|
| 92 | return $this->call('list', [$params], GoogleCloudApigeeV1ListAppsResponse::class);
|
---|
| 93 | }
|
---|
| 94 | }
|
---|
| 95 |
|
---|
| 96 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
| 97 | class_alias(OrganizationsApps::class, 'Google_Service_Apigee_Resource_OrganizationsApps');
|
---|