source: vendor/google/apiclient-services/src/Apigee/Resource/OrganizationsSitesApidocs.php

Last change on this file was e3d4e0a, checked in by Vlado 222039 <vlado.popovski@…>, 9 days ago

Upload project files

  • Property mode set to 100644
File size: 6.6 KB
Line 
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\GoogleCloudApigeeV1ApiDoc;
21use Google\Service\Apigee\GoogleCloudApigeeV1ApiDocDocumentation;
22use Google\Service\Apigee\GoogleCloudApigeeV1ApiDocDocumentationResponse;
23use Google\Service\Apigee\GoogleCloudApigeeV1ApiDocResponse;
24use Google\Service\Apigee\GoogleCloudApigeeV1DeleteResponse;
25use Google\Service\Apigee\GoogleCloudApigeeV1ListApiDocsResponse;
26
27/**
28 * The "apidocs" collection of methods.
29 * Typical usage is:
30 * <code>
31 * $apigeeService = new Google\Service\Apigee(...);
32 * $apidocs = $apigeeService->organizations_sites_apidocs;
33 * </code>
34 */
35class OrganizationsSitesApidocs extends \Google\Service\Resource
36{
37 /**
38 * Creates a new catalog item. (apidocs.create)
39 *
40 * @param string $parent Required. Name of the portal. Use the following
41 * structure in your request: `organizations/{org}/sites/{site}`
42 * @param GoogleCloudApigeeV1ApiDoc $postBody
43 * @param array $optParams Optional parameters.
44 * @return GoogleCloudApigeeV1ApiDocResponse
45 * @throws \Google\Service\Exception
46 */
47 public function create($parent, GoogleCloudApigeeV1ApiDoc $postBody, $optParams = [])
48 {
49 $params = ['parent' => $parent, 'postBody' => $postBody];
50 $params = array_merge($params, $optParams);
51 return $this->call('create', [$params], GoogleCloudApigeeV1ApiDocResponse::class);
52 }
53 /**
54 * Deletes a catalog item. (apidocs.delete)
55 *
56 * @param string $name Required. Name of the catalog item. Use the following
57 * structure in your request:
58 * `organizations/{org}/sites/{site}/apidocs/{apidoc}`
59 * @param array $optParams Optional parameters.
60 * @return GoogleCloudApigeeV1DeleteResponse
61 * @throws \Google\Service\Exception
62 */
63 public function delete($name, $optParams = [])
64 {
65 $params = ['name' => $name];
66 $params = array_merge($params, $optParams);
67 return $this->call('delete', [$params], GoogleCloudApigeeV1DeleteResponse::class);
68 }
69 /**
70 * Gets a catalog item. (apidocs.get)
71 *
72 * @param string $name Required. Name of the catalog item. Use the following
73 * structure in your request:
74 * `organizations/{org}/sites/{site}/apidocs/{apidoc}`
75 * @param array $optParams Optional parameters.
76 * @return GoogleCloudApigeeV1ApiDocResponse
77 * @throws \Google\Service\Exception
78 */
79 public function get($name, $optParams = [])
80 {
81 $params = ['name' => $name];
82 $params = array_merge($params, $optParams);
83 return $this->call('get', [$params], GoogleCloudApigeeV1ApiDocResponse::class);
84 }
85 /**
86 * Gets the documentation for the specified catalog item.
87 * (apidocs.getDocumentation)
88 *
89 * @param string $name Required. Resource name of the catalog item
90 * documentation. Use the following structure in your request:
91 * `organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation`
92 * @param array $optParams Optional parameters.
93 * @return GoogleCloudApigeeV1ApiDocDocumentationResponse
94 * @throws \Google\Service\Exception
95 */
96 public function getDocumentation($name, $optParams = [])
97 {
98 $params = ['name' => $name];
99 $params = array_merge($params, $optParams);
100 return $this->call('getDocumentation', [$params], GoogleCloudApigeeV1ApiDocDocumentationResponse::class);
101 }
102 /**
103 * Returns the catalog items associated with a portal.
104 * (apidocs.listOrganizationsSitesApidocs)
105 *
106 * @param string $parent Required. Name of the portal. Use the following
107 * structure in your request: `organizations/{org}/sites/{site}`
108 * @param array $optParams Optional parameters.
109 *
110 * @opt_param int pageSize Optional. The maximum number of items to return. The
111 * service may return fewer than this value. If unspecified, at most 25 books
112 * will be returned. The maximum value is 100; values above 100 will be coerced
113 * to 100.
114 * @opt_param string pageToken Optional. A page token, received from a previous
115 * `ListApiDocs` call. Provide this to retrieve the subsequent page.
116 * @return GoogleCloudApigeeV1ListApiDocsResponse
117 * @throws \Google\Service\Exception
118 */
119 public function listOrganizationsSitesApidocs($parent, $optParams = [])
120 {
121 $params = ['parent' => $parent];
122 $params = array_merge($params, $optParams);
123 return $this->call('list', [$params], GoogleCloudApigeeV1ListApiDocsResponse::class);
124 }
125 /**
126 * Updates a catalog item. (apidocs.update)
127 *
128 * @param string $name Required. Name of the catalog item. Use the following
129 * structure in your request:
130 * `organizations/{org}/sites/{site}/apidocs/{apidoc}`
131 * @param GoogleCloudApigeeV1ApiDoc $postBody
132 * @param array $optParams Optional parameters.
133 * @return GoogleCloudApigeeV1ApiDocResponse
134 * @throws \Google\Service\Exception
135 */
136 public function update($name, GoogleCloudApigeeV1ApiDoc $postBody, $optParams = [])
137 {
138 $params = ['name' => $name, 'postBody' => $postBody];
139 $params = array_merge($params, $optParams);
140 return $this->call('update', [$params], GoogleCloudApigeeV1ApiDocResponse::class);
141 }
142 /**
143 * Updates the documentation for the specified catalog item. Note that the
144 * documentation file contents will not be populated in the return message.
145 * (apidocs.updateDocumentation)
146 *
147 * @param string $name Required. Resource name of the catalog item
148 * documentation. Use the following structure in your request:
149 * `organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation`
150 * @param GoogleCloudApigeeV1ApiDocDocumentation $postBody
151 * @param array $optParams Optional parameters.
152 * @return GoogleCloudApigeeV1ApiDocDocumentationResponse
153 * @throws \Google\Service\Exception
154 */
155 public function updateDocumentation($name, GoogleCloudApigeeV1ApiDocDocumentation $postBody, $optParams = [])
156 {
157 $params = ['name' => $name, 'postBody' => $postBody];
158 $params = array_merge($params, $optParams);
159 return $this->call('updateDocumentation', [$params], GoogleCloudApigeeV1ApiDocDocumentationResponse::class);
160 }
161}
162
163// Adding a class alias for backwards compatibility with the previous class name.
164class_alias(OrganizationsSitesApidocs::class, 'Google_Service_Apigee_Resource_OrganizationsSitesApidocs');
Note: See TracBrowser for help on using the repository browser.