gestione documentale avanzata 1 parte

This commit is contained in:
2026-05-28 09:34:28 +02:00
parent 3471befb1a
commit f2b0833b90
34482 changed files with 4312269 additions and 546 deletions
@@ -0,0 +1,115 @@
<?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\AccessApproval\Resource;
use Google\Service\AccessApproval\AccessApprovalServiceAccount;
use Google\Service\AccessApproval\AccessApprovalSettings;
use Google\Service\AccessApproval\AccessapprovalEmpty;
/**
* The "folders" collection of methods.
* Typical usage is:
* <code>
* $accessapprovalService = new Google\Service\AccessApproval(...);
* $folders = $accessapprovalService->folders;
* </code>
*/
class Folders extends \Google\Service\Resource
{
/**
* Deletes the settings associated with a project, folder, or organization. This
* will have the effect of disabling Access Approval for the resource. Access
* Approval may remain active based on parent resource settings. To confirm the
* effective settings, call GetAccessApprovalSettings and verify effective
* setting is disabled. (folders.deleteAccessApprovalSettings)
*
* @param string $name Name of the AccessApprovalSettings to delete.
* @param array $optParams Optional parameters.
* @return AccessapprovalEmpty
* @throws \Google\Service\Exception
*/
public function deleteAccessApprovalSettings($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('deleteAccessApprovalSettings', [$params], AccessapprovalEmpty::class);
}
/**
* Gets the Access Approval settings associated with a project, folder, or
* organization. (folders.getAccessApprovalSettings)
*
* @param string $name The name of the AccessApprovalSettings to retrieve.
* Format: "{projects|folders|organizations}/{id}/accessApprovalSettings"
* @param array $optParams Optional parameters.
* @return AccessApprovalSettings
* @throws \Google\Service\Exception
*/
public function getAccessApprovalSettings($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('getAccessApprovalSettings', [$params], AccessApprovalSettings::class);
}
/**
* Retrieves the service account that is used by Access Approval to access KMS
* keys for signing approved approval requests. (folders.getServiceAccount)
*
* @param string $name Name of the AccessApprovalServiceAccount to retrieve.
* @param array $optParams Optional parameters.
* @return AccessApprovalServiceAccount
* @throws \Google\Service\Exception
*/
public function getServiceAccount($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('getServiceAccount', [$params], AccessApprovalServiceAccount::class);
}
/**
* Updates the settings associated with a project, folder, or organization.
* Settings to update are determined by the value of field_mask.
* (folders.updateAccessApprovalSettings)
*
* @param string $name The resource name of the settings. Format is one of: *
* "projects/{project}/accessApprovalSettings" *
* "folders/{folder}/accessApprovalSettings" *
* "organizations/{organization}/accessApprovalSettings"
* @param AccessApprovalSettings $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string updateMask The update mask applies to the settings. Only
* the top level fields of AccessApprovalSettings (notification_emails &
* enrolled_services) are supported. For each field, if it is included, the
* currently stored value will be entirely overwritten with the value of the
* field passed in this request. For the `FieldMask` definition, see
* https://developers.google.com/protocol-
* buffers/docs/reference/google.protobuf#fieldmask If this field is left unset,
* only the notification_emails field will be updated.
* @return AccessApprovalSettings
* @throws \Google\Service\Exception
*/
public function updateAccessApprovalSettings($name, AccessApprovalSettings $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('updateAccessApprovalSettings', [$params], AccessApprovalSettings::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Folders::class, 'Google_Service_AccessApproval_Resource_Folders');
@@ -0,0 +1,140 @@
<?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\AccessApproval\Resource;
use Google\Service\AccessApproval\ApprovalRequest;
use Google\Service\AccessApproval\ApproveApprovalRequestMessage;
use Google\Service\AccessApproval\DismissApprovalRequestMessage;
use Google\Service\AccessApproval\InvalidateApprovalRequestMessage;
use Google\Service\AccessApproval\ListApprovalRequestsResponse;
/**
* The "approvalRequests" collection of methods.
* Typical usage is:
* <code>
* $accessapprovalService = new Google\Service\AccessApproval(...);
* $approvalRequests = $accessapprovalService->folders_approvalRequests;
* </code>
*/
class FoldersApprovalRequests extends \Google\Service\Resource
{
/**
* Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND
* if the request does not exist. Returns FAILED_PRECONDITION if the request
* exists but is not in a pending state. (approvalRequests.approve)
*
* @param string $name Name of the approval request to approve.
* @param ApproveApprovalRequestMessage $postBody
* @param array $optParams Optional parameters.
* @return ApprovalRequest
* @throws \Google\Service\Exception
*/
public function approve($name, ApproveApprovalRequestMessage $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('approve', [$params], ApprovalRequest::class);
}
/**
* Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a
* request is dismissed, it is considered ignored. Dismissing a request does not
* prevent access granted by other Access Approval requests. Returns NOT_FOUND
* if the request does not exist. Returns FAILED_PRECONDITION if the request
* exists but is not in a pending state. (approvalRequests.dismiss)
*
* @param string $name Name of the ApprovalRequest to dismiss.
* @param DismissApprovalRequestMessage $postBody
* @param array $optParams Optional parameters.
* @return ApprovalRequest
* @throws \Google\Service\Exception
*/
public function dismiss($name, DismissApprovalRequestMessage $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('dismiss', [$params], ApprovalRequest::class);
}
/**
* Gets an approval request. Returns NOT_FOUND if the request does not exist.
* (approvalRequests.get)
*
* @param string $name The name of the approval request to retrieve. Format:
* "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}"
* @param array $optParams Optional parameters.
* @return ApprovalRequest
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], ApprovalRequest::class);
}
/**
* Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest.
* NOTE: This action revokes Google access based on this approval request. If
* the resource has other active approvals, access will remain granted. Returns
* FAILED_PRECONDITION if the request exists but is not in an approved state.
* (approvalRequests.invalidate)
*
* @param string $name Name of the ApprovalRequest to invalidate.
* @param InvalidateApprovalRequestMessage $postBody
* @param array $optParams Optional parameters.
* @return ApprovalRequest
* @throws \Google\Service\Exception
*/
public function invalidate($name, InvalidateApprovalRequestMessage $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('invalidate', [$params], ApprovalRequest::class);
}
/**
* Lists approval requests associated with a project, folder, or organization.
* Approval requests can be filtered by state (pending, active, dismissed). The
* order is reverse chronological.
* (approvalRequests.listFoldersApprovalRequests)
*
* @param string $parent The parent resource. This may be "projects/{project}",
* "folders/{folder}", or "organizations/{organization}".
* @param array $optParams Optional parameters.
*
* @opt_param string filter A filter on the type of approval requests to
* retrieve. Must be one of the following values: * [not set]: Requests that are
* pending or have active approvals. * ALL: All requests. * PENDING: Only
* pending requests. * ACTIVE: Only active (i.e. currently approved) requests. *
* DISMISSED: Only requests that have been dismissed, or requests that are not
* approved and past expiration. * EXPIRED: Only requests that have been
* approved, and the approval has expired. * HISTORY: Active, dismissed and
* expired requests.
* @opt_param int pageSize Requested page size.
* @opt_param string pageToken A token identifying the page of results to
* return.
* @return ListApprovalRequestsResponse
* @throws \Google\Service\Exception
*/
public function listFoldersApprovalRequests($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListApprovalRequestsResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(FoldersApprovalRequests::class, 'Google_Service_AccessApproval_Resource_FoldersApprovalRequests');
@@ -0,0 +1,116 @@
<?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\AccessApproval\Resource;
use Google\Service\AccessApproval\AccessApprovalServiceAccount;
use Google\Service\AccessApproval\AccessApprovalSettings;
use Google\Service\AccessApproval\AccessapprovalEmpty;
/**
* The "organizations" collection of methods.
* Typical usage is:
* <code>
* $accessapprovalService = new Google\Service\AccessApproval(...);
* $organizations = $accessapprovalService->organizations;
* </code>
*/
class Organizations extends \Google\Service\Resource
{
/**
* Deletes the settings associated with a project, folder, or organization. This
* will have the effect of disabling Access Approval for the resource. Access
* Approval may remain active based on parent resource settings. To confirm the
* effective settings, call GetAccessApprovalSettings and verify effective
* setting is disabled. (organizations.deleteAccessApprovalSettings)
*
* @param string $name Name of the AccessApprovalSettings to delete.
* @param array $optParams Optional parameters.
* @return AccessapprovalEmpty
* @throws \Google\Service\Exception
*/
public function deleteAccessApprovalSettings($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('deleteAccessApprovalSettings', [$params], AccessapprovalEmpty::class);
}
/**
* Gets the Access Approval settings associated with a project, folder, or
* organization. (organizations.getAccessApprovalSettings)
*
* @param string $name The name of the AccessApprovalSettings to retrieve.
* Format: "{projects|folders|organizations}/{id}/accessApprovalSettings"
* @param array $optParams Optional parameters.
* @return AccessApprovalSettings
* @throws \Google\Service\Exception
*/
public function getAccessApprovalSettings($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('getAccessApprovalSettings', [$params], AccessApprovalSettings::class);
}
/**
* Retrieves the service account that is used by Access Approval to access KMS
* keys for signing approved approval requests.
* (organizations.getServiceAccount)
*
* @param string $name Name of the AccessApprovalServiceAccount to retrieve.
* @param array $optParams Optional parameters.
* @return AccessApprovalServiceAccount
* @throws \Google\Service\Exception
*/
public function getServiceAccount($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('getServiceAccount', [$params], AccessApprovalServiceAccount::class);
}
/**
* Updates the settings associated with a project, folder, or organization.
* Settings to update are determined by the value of field_mask.
* (organizations.updateAccessApprovalSettings)
*
* @param string $name The resource name of the settings. Format is one of: *
* "projects/{project}/accessApprovalSettings" *
* "folders/{folder}/accessApprovalSettings" *
* "organizations/{organization}/accessApprovalSettings"
* @param AccessApprovalSettings $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string updateMask The update mask applies to the settings. Only
* the top level fields of AccessApprovalSettings (notification_emails &
* enrolled_services) are supported. For each field, if it is included, the
* currently stored value will be entirely overwritten with the value of the
* field passed in this request. For the `FieldMask` definition, see
* https://developers.google.com/protocol-
* buffers/docs/reference/google.protobuf#fieldmask If this field is left unset,
* only the notification_emails field will be updated.
* @return AccessApprovalSettings
* @throws \Google\Service\Exception
*/
public function updateAccessApprovalSettings($name, AccessApprovalSettings $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('updateAccessApprovalSettings', [$params], AccessApprovalSettings::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Organizations::class, 'Google_Service_AccessApproval_Resource_Organizations');
@@ -0,0 +1,140 @@
<?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\AccessApproval\Resource;
use Google\Service\AccessApproval\ApprovalRequest;
use Google\Service\AccessApproval\ApproveApprovalRequestMessage;
use Google\Service\AccessApproval\DismissApprovalRequestMessage;
use Google\Service\AccessApproval\InvalidateApprovalRequestMessage;
use Google\Service\AccessApproval\ListApprovalRequestsResponse;
/**
* The "approvalRequests" collection of methods.
* Typical usage is:
* <code>
* $accessapprovalService = new Google\Service\AccessApproval(...);
* $approvalRequests = $accessapprovalService->organizations_approvalRequests;
* </code>
*/
class OrganizationsApprovalRequests extends \Google\Service\Resource
{
/**
* Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND
* if the request does not exist. Returns FAILED_PRECONDITION if the request
* exists but is not in a pending state. (approvalRequests.approve)
*
* @param string $name Name of the approval request to approve.
* @param ApproveApprovalRequestMessage $postBody
* @param array $optParams Optional parameters.
* @return ApprovalRequest
* @throws \Google\Service\Exception
*/
public function approve($name, ApproveApprovalRequestMessage $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('approve', [$params], ApprovalRequest::class);
}
/**
* Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a
* request is dismissed, it is considered ignored. Dismissing a request does not
* prevent access granted by other Access Approval requests. Returns NOT_FOUND
* if the request does not exist. Returns FAILED_PRECONDITION if the request
* exists but is not in a pending state. (approvalRequests.dismiss)
*
* @param string $name Name of the ApprovalRequest to dismiss.
* @param DismissApprovalRequestMessage $postBody
* @param array $optParams Optional parameters.
* @return ApprovalRequest
* @throws \Google\Service\Exception
*/
public function dismiss($name, DismissApprovalRequestMessage $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('dismiss', [$params], ApprovalRequest::class);
}
/**
* Gets an approval request. Returns NOT_FOUND if the request does not exist.
* (approvalRequests.get)
*
* @param string $name The name of the approval request to retrieve. Format:
* "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}"
* @param array $optParams Optional parameters.
* @return ApprovalRequest
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], ApprovalRequest::class);
}
/**
* Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest.
* NOTE: This action revokes Google access based on this approval request. If
* the resource has other active approvals, access will remain granted. Returns
* FAILED_PRECONDITION if the request exists but is not in an approved state.
* (approvalRequests.invalidate)
*
* @param string $name Name of the ApprovalRequest to invalidate.
* @param InvalidateApprovalRequestMessage $postBody
* @param array $optParams Optional parameters.
* @return ApprovalRequest
* @throws \Google\Service\Exception
*/
public function invalidate($name, InvalidateApprovalRequestMessage $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('invalidate', [$params], ApprovalRequest::class);
}
/**
* Lists approval requests associated with a project, folder, or organization.
* Approval requests can be filtered by state (pending, active, dismissed). The
* order is reverse chronological.
* (approvalRequests.listOrganizationsApprovalRequests)
*
* @param string $parent The parent resource. This may be "projects/{project}",
* "folders/{folder}", or "organizations/{organization}".
* @param array $optParams Optional parameters.
*
* @opt_param string filter A filter on the type of approval requests to
* retrieve. Must be one of the following values: * [not set]: Requests that are
* pending or have active approvals. * ALL: All requests. * PENDING: Only
* pending requests. * ACTIVE: Only active (i.e. currently approved) requests. *
* DISMISSED: Only requests that have been dismissed, or requests that are not
* approved and past expiration. * EXPIRED: Only requests that have been
* approved, and the approval has expired. * HISTORY: Active, dismissed and
* expired requests.
* @opt_param int pageSize Requested page size.
* @opt_param string pageToken A token identifying the page of results to
* return.
* @return ListApprovalRequestsResponse
* @throws \Google\Service\Exception
*/
public function listOrganizationsApprovalRequests($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListApprovalRequestsResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(OrganizationsApprovalRequests::class, 'Google_Service_AccessApproval_Resource_OrganizationsApprovalRequests');
@@ -0,0 +1,115 @@
<?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\AccessApproval\Resource;
use Google\Service\AccessApproval\AccessApprovalServiceAccount;
use Google\Service\AccessApproval\AccessApprovalSettings;
use Google\Service\AccessApproval\AccessapprovalEmpty;
/**
* The "projects" collection of methods.
* Typical usage is:
* <code>
* $accessapprovalService = new Google\Service\AccessApproval(...);
* $projects = $accessapprovalService->projects;
* </code>
*/
class Projects extends \Google\Service\Resource
{
/**
* Deletes the settings associated with a project, folder, or organization. This
* will have the effect of disabling Access Approval for the resource. Access
* Approval may remain active based on parent resource settings. To confirm the
* effective settings, call GetAccessApprovalSettings and verify effective
* setting is disabled. (projects.deleteAccessApprovalSettings)
*
* @param string $name Name of the AccessApprovalSettings to delete.
* @param array $optParams Optional parameters.
* @return AccessapprovalEmpty
* @throws \Google\Service\Exception
*/
public function deleteAccessApprovalSettings($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('deleteAccessApprovalSettings', [$params], AccessapprovalEmpty::class);
}
/**
* Gets the Access Approval settings associated with a project, folder, or
* organization. (projects.getAccessApprovalSettings)
*
* @param string $name The name of the AccessApprovalSettings to retrieve.
* Format: "{projects|folders|organizations}/{id}/accessApprovalSettings"
* @param array $optParams Optional parameters.
* @return AccessApprovalSettings
* @throws \Google\Service\Exception
*/
public function getAccessApprovalSettings($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('getAccessApprovalSettings', [$params], AccessApprovalSettings::class);
}
/**
* Retrieves the service account that is used by Access Approval to access KMS
* keys for signing approved approval requests. (projects.getServiceAccount)
*
* @param string $name Name of the AccessApprovalServiceAccount to retrieve.
* @param array $optParams Optional parameters.
* @return AccessApprovalServiceAccount
* @throws \Google\Service\Exception
*/
public function getServiceAccount($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('getServiceAccount', [$params], AccessApprovalServiceAccount::class);
}
/**
* Updates the settings associated with a project, folder, or organization.
* Settings to update are determined by the value of field_mask.
* (projects.updateAccessApprovalSettings)
*
* @param string $name The resource name of the settings. Format is one of: *
* "projects/{project}/accessApprovalSettings" *
* "folders/{folder}/accessApprovalSettings" *
* "organizations/{organization}/accessApprovalSettings"
* @param AccessApprovalSettings $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string updateMask The update mask applies to the settings. Only
* the top level fields of AccessApprovalSettings (notification_emails &
* enrolled_services) are supported. For each field, if it is included, the
* currently stored value will be entirely overwritten with the value of the
* field passed in this request. For the `FieldMask` definition, see
* https://developers.google.com/protocol-
* buffers/docs/reference/google.protobuf#fieldmask If this field is left unset,
* only the notification_emails field will be updated.
* @return AccessApprovalSettings
* @throws \Google\Service\Exception
*/
public function updateAccessApprovalSettings($name, AccessApprovalSettings $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('updateAccessApprovalSettings', [$params], AccessApprovalSettings::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Projects::class, 'Google_Service_AccessApproval_Resource_Projects');
@@ -0,0 +1,140 @@
<?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\AccessApproval\Resource;
use Google\Service\AccessApproval\ApprovalRequest;
use Google\Service\AccessApproval\ApproveApprovalRequestMessage;
use Google\Service\AccessApproval\DismissApprovalRequestMessage;
use Google\Service\AccessApproval\InvalidateApprovalRequestMessage;
use Google\Service\AccessApproval\ListApprovalRequestsResponse;
/**
* The "approvalRequests" collection of methods.
* Typical usage is:
* <code>
* $accessapprovalService = new Google\Service\AccessApproval(...);
* $approvalRequests = $accessapprovalService->projects_approvalRequests;
* </code>
*/
class ProjectsApprovalRequests extends \Google\Service\Resource
{
/**
* Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND
* if the request does not exist. Returns FAILED_PRECONDITION if the request
* exists but is not in a pending state. (approvalRequests.approve)
*
* @param string $name Name of the approval request to approve.
* @param ApproveApprovalRequestMessage $postBody
* @param array $optParams Optional parameters.
* @return ApprovalRequest
* @throws \Google\Service\Exception
*/
public function approve($name, ApproveApprovalRequestMessage $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('approve', [$params], ApprovalRequest::class);
}
/**
* Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a
* request is dismissed, it is considered ignored. Dismissing a request does not
* prevent access granted by other Access Approval requests. Returns NOT_FOUND
* if the request does not exist. Returns FAILED_PRECONDITION if the request
* exists but is not in a pending state. (approvalRequests.dismiss)
*
* @param string $name Name of the ApprovalRequest to dismiss.
* @param DismissApprovalRequestMessage $postBody
* @param array $optParams Optional parameters.
* @return ApprovalRequest
* @throws \Google\Service\Exception
*/
public function dismiss($name, DismissApprovalRequestMessage $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('dismiss', [$params], ApprovalRequest::class);
}
/**
* Gets an approval request. Returns NOT_FOUND if the request does not exist.
* (approvalRequests.get)
*
* @param string $name The name of the approval request to retrieve. Format:
* "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}"
* @param array $optParams Optional parameters.
* @return ApprovalRequest
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], ApprovalRequest::class);
}
/**
* Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest.
* NOTE: This action revokes Google access based on this approval request. If
* the resource has other active approvals, access will remain granted. Returns
* FAILED_PRECONDITION if the request exists but is not in an approved state.
* (approvalRequests.invalidate)
*
* @param string $name Name of the ApprovalRequest to invalidate.
* @param InvalidateApprovalRequestMessage $postBody
* @param array $optParams Optional parameters.
* @return ApprovalRequest
* @throws \Google\Service\Exception
*/
public function invalidate($name, InvalidateApprovalRequestMessage $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('invalidate', [$params], ApprovalRequest::class);
}
/**
* Lists approval requests associated with a project, folder, or organization.
* Approval requests can be filtered by state (pending, active, dismissed). The
* order is reverse chronological.
* (approvalRequests.listProjectsApprovalRequests)
*
* @param string $parent The parent resource. This may be "projects/{project}",
* "folders/{folder}", or "organizations/{organization}".
* @param array $optParams Optional parameters.
*
* @opt_param string filter A filter on the type of approval requests to
* retrieve. Must be one of the following values: * [not set]: Requests that are
* pending or have active approvals. * ALL: All requests. * PENDING: Only
* pending requests. * ACTIVE: Only active (i.e. currently approved) requests. *
* DISMISSED: Only requests that have been dismissed, or requests that are not
* approved and past expiration. * EXPIRED: Only requests that have been
* approved, and the approval has expired. * HISTORY: Active, dismissed and
* expired requests.
* @opt_param int pageSize Requested page size.
* @opt_param string pageToken A token identifying the page of results to
* return.
* @return ListApprovalRequestsResponse
* @throws \Google\Service\Exception
*/
public function listProjectsApprovalRequests($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListApprovalRequestsResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsApprovalRequests::class, 'Google_Service_AccessApproval_Resource_ProjectsApprovalRequests');