File "ProjectsLocationsAgentsWebhooks.php"
Full Path: /home/u743136113/domains/arvi.seezify.com/public_html/vendor/google/apiclient-services/src/Dialogflow/Resource/ProjectsLocationsAgentsWebhooks.php
File size: 5.27 KB
MIME-type: text/x-php
Charset: utf-8
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Dialogflow\Resource;
use Google\Service\Dialogflow\GoogleCloudDialogflowCxV3ListWebhooksResponse;
use Google\Service\Dialogflow\GoogleCloudDialogflowCxV3Webhook;
use Google\Service\Dialogflow\GoogleProtobufEmpty;
/**
* The "webhooks" collection of methods.
* Typical usage is:
* <code>
* $dialogflowService = new Google\Service\Dialogflow(...);
* $webhooks = $dialogflowService->projects_locations_agents_webhooks;
* </code>
*/
class ProjectsLocationsAgentsWebhooks extends \Google\Service\Resource
{
/**
* Creates a webhook in the specified agent. (webhooks.create)
*
* @param string $parent Required. The agent to create a webhook for. Format:
* `projects//locations//agents/`.
* @param GoogleCloudDialogflowCxV3Webhook $postBody
* @param array $optParams Optional parameters.
* @return GoogleCloudDialogflowCxV3Webhook
* @throws \Google\Service\Exception
*/
public function create($parent, GoogleCloudDialogflowCxV3Webhook $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], GoogleCloudDialogflowCxV3Webhook::class);
}
/**
* Deletes the specified webhook. (webhooks.delete)
*
* @param string $name Required. The name of the webhook to delete. Format:
* `projects//locations//agents//webhooks/`.
* @param array $optParams Optional parameters.
*
* @opt_param bool force This field has no effect for webhook not being used.
* For webhooks that are used by pages/flows/transition route groups: * If
* `force` is set to false, an error will be returned with message indicating
* the referenced resources. * If `force` is set to true, Dialogflow will remove
* the webhook, as well as any references to the webhook (i.e. Webhook and tagin
* fulfillments that point to this webhook will be removed).
* @return GoogleProtobufEmpty
* @throws \Google\Service\Exception
*/
public function delete($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], GoogleProtobufEmpty::class);
}
/**
* Retrieves the specified webhook. (webhooks.get)
*
* @param string $name Required. The name of the webhook. Format:
* `projects//locations//agents//webhooks/`.
* @param array $optParams Optional parameters.
* @return GoogleCloudDialogflowCxV3Webhook
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], GoogleCloudDialogflowCxV3Webhook::class);
}
/**
* Returns the list of all webhooks in the specified agent.
* (webhooks.listProjectsLocationsAgentsWebhooks)
*
* @param string $parent Required. The agent to list all webhooks for. Format:
* `projects//locations//agents/`.
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize The maximum number of items to return in a single
* page. By default 100 and at most 1000.
* @opt_param string pageToken The next_page_token value returned from a
* previous list request.
* @return GoogleCloudDialogflowCxV3ListWebhooksResponse
* @throws \Google\Service\Exception
*/
public function listProjectsLocationsAgentsWebhooks($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], GoogleCloudDialogflowCxV3ListWebhooksResponse::class);
}
/**
* Updates the specified webhook. (webhooks.patch)
*
* @param string $name The unique identifier of the webhook. Required for the
* Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name
* automatically. Format: `projects//locations//agents//webhooks/`.
* @param GoogleCloudDialogflowCxV3Webhook $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string updateMask The mask to control which fields get updated. If
* the mask is not present, all fields will be updated.
* @return GoogleCloudDialogflowCxV3Webhook
* @throws \Google\Service\Exception
*/
public function patch($name, GoogleCloudDialogflowCxV3Webhook $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], GoogleCloudDialogflowCxV3Webhook::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsLocationsAgentsWebhooks::class, 'Google_Service_Dialogflow_Resource_ProjectsLocationsAgentsWebhooks');