class ProvidersEntitlements extends Resource (View source)

The "entitlements" collection of methods.

Typical usage is:

 $cloudcommerceprocurementService = new Google\Service\CloudCommercePartnerProcurementService(...);
 $entitlements = $cloudcommerceprocurementService->providers_entitlements;

Methods

approve(string $name, ApproveEntitlementRequest $postBody, array $optParams = [])

Approves an entitlement that is in the EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is invoked by the provider to approve the creation of the entitlement resource.

approvePlanChange(string $name, ApproveEntitlementPlanChangeRequest $postBody, array $optParams = [])

Approves an entitlement plan change that is in the EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This method is invoked by the provider to approve the plan change on the entitlement resource. (entitlements.approvePlanChange)

get(string $name, array $optParams = [])

Gets a requested Entitlement resource. (entitlements.get)

listProvidersEntitlements(string $parent, array $optParams = [])

Lists Entitlements for which the provider has read access.

patch(string $name, Entitlement $postBody, array $optParams = [])

Updates an existing Entitlement. (entitlements.patch)

reject(string $name, RejectEntitlementRequest $postBody, array $optParams = [])

Rejects an entitlement that is in the EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is invoked by the provider to reject the creation of the entitlement resource.

rejectPlanChange(string $name, RejectEntitlementPlanChangeRequest $postBody, array $optParams = [])

Rejects an entitlement plan change that is in the EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This method is invoked by the provider to reject the plan change on the entitlement resource. (entitlements.rejectPlanChange)

suspend(string $name, SuspendEntitlementRequest $postBody, array $optParams = [])

Requests suspension of an active Entitlement. This is not yet supported.

Details

CloudcommerceprocurementEmpty approve(string $name, ApproveEntitlementRequest $postBody, array $optParams = [])

Approves an entitlement that is in the EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is invoked by the provider to approve the creation of the entitlement resource.

(entitlements.approve)

Parameters

string $name

Required. The resource name of the entitlement, with the format providers/{providerId}/entitlements/{entitlementId}.

ApproveEntitlementRequest $postBody
array $optParams

Optional parameters.

Return Value

CloudcommerceprocurementEmpty

Exceptions

Exception

CloudcommerceprocurementEmpty approvePlanChange(string $name, ApproveEntitlementPlanChangeRequest $postBody, array $optParams = [])

Approves an entitlement plan change that is in the EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This method is invoked by the provider to approve the plan change on the entitlement resource. (entitlements.approvePlanChange)

Parameters

string $name

Required. The resource name of the entitlement.

ApproveEntitlementPlanChangeRequest $postBody
array $optParams

Optional parameters.

Return Value

CloudcommerceprocurementEmpty

Exceptions

Exception

Entitlement get(string $name, array $optParams = [])

Gets a requested Entitlement resource. (entitlements.get)

Parameters

string $name

Required. The name of the entitlement to retrieve.

array $optParams

Optional parameters.

Return Value

Entitlement

Exceptions

Exception

ListEntitlementsResponse listProvidersEntitlements(string $parent, array $optParams = [])

Lists Entitlements for which the provider has read access.

(entitlements.listProvidersEntitlements)

Parameters

string $parent

Required. The parent resource name.

array $optParams

Optional parameters.

Return Value

ListEntitlementsResponse

Exceptions

Exception

Entitlement patch(string $name, Entitlement $postBody, array $optParams = [])

Updates an existing Entitlement. (entitlements.patch)

Parameters

string $name

Required. The name of the entitlement to update.

Entitlement $postBody
array $optParams

Optional parameters.

Return Value

Entitlement

Exceptions

Exception

CloudcommerceprocurementEmpty reject(string $name, RejectEntitlementRequest $postBody, array $optParams = [])

Rejects an entitlement that is in the EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is invoked by the provider to reject the creation of the entitlement resource.

(entitlements.reject)

Parameters

string $name

Required. The resource name of the entitlement.

RejectEntitlementRequest $postBody
array $optParams

Optional parameters.

Return Value

CloudcommerceprocurementEmpty

Exceptions

Exception

CloudcommerceprocurementEmpty rejectPlanChange(string $name, RejectEntitlementPlanChangeRequest $postBody, array $optParams = [])

Rejects an entitlement plan change that is in the EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This method is invoked by the provider to reject the plan change on the entitlement resource. (entitlements.rejectPlanChange)

Parameters

string $name

Required. The resource name of the entitlement.

RejectEntitlementPlanChangeRequest $postBody
array $optParams

Optional parameters.

Return Value

CloudcommerceprocurementEmpty

Exceptions

Exception

CloudcommerceprocurementEmpty suspend(string $name, SuspendEntitlementRequest $postBody, array $optParams = [])

Requests suspension of an active Entitlement. This is not yet supported.

(entitlements.suspend)

Parameters

string $name

Required. The name of the entitlement to suspend.

SuspendEntitlementRequest $postBody
array $optParams

Optional parameters.

Return Value

CloudcommerceprocurementEmpty

Exceptions

Exception