2024-06-15
▼ ▲ cloudcommerceprocurement.providers.accounts.approve
Flat Path : v1/providers/{providersId}/accounts/{accountsId}:approve
Path : v1/{+name}:approve
Parameter Order : name
Description : Grants an approval on an Account.
Parameters :
name
Required : Yes
Description : Required. The resource name of the account, with the format `providers/{providerId}/accounts/{accountId}`.
Pattern : ^providers/[^/]+/accounts/[^/]+$
Type : string
Location : path
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
▼ ▲ cloudcommerceprocurement.providers.accounts.list
Parameters :
pageToken
Location : query
Type : string
Description : The token for fetching the next page.
parent
Pattern : ^providers/[^/]+$
Location : path
Description : Required. The parent resource name.
Type : string
Required : Yes
pageSize
Type : integer
Format : int32
Location : query
Description : The maximum number of entries that are requested. The default page size is 25 and the maximum page size is 200.
HTTP Method : GET
Description : Lists Accounts that the provider has access to.
Path : v1/{+parent}/accounts
Parameter Order : parent
Flat Path : v1/providers/{providersId}/accounts
▼ ▲ cloudcommerceprocurement.providers.accounts.reject
Description : Rejects an approval on an Account.
HTTP Method : POST
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}:reject
Flat Path : v1/providers/{providersId}/accounts/{accountsId}:reject
Parameters :
name
Type : string
Required : Yes
Location : path
Pattern : ^providers/[^/]+/accounts/[^/]+$
Description : Required. The resource name of the account.
▼ ▲ cloudcommerceprocurement.providers.accounts.reset
Parameter Order : name
HTTP Method : POST
Parameters :
name
Location : path
Required : Yes
Pattern : ^providers/[^/]+/accounts/[^/]+$
Type : string
Description : Required. The resource name of the account.
Description : Resets an Account and cancels all associated Entitlements. Partner can only reset accounts they own rather than customer accounts.
Flat Path : v1/providers/{providersId}/accounts/{accountsId}:reset
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}:reset
▼ ▲ cloudcommerceprocurement.providers.accounts.get
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Description : Required. The name of the account to retrieve.
Location : path
Required : Yes
Pattern : ^providers/[^/]+/accounts/[^/]+$
Flat Path : v1/providers/{providersId}/accounts/{accountsId}
Description : Gets a requested Account resource.
Path : v1/{+name}
Parameter Order : name
▼ ▲ cloudcommerceprocurement.providers.entitlements.rejectPlanChange
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}:rejectPlanChange
Description : 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.
Parameters :
name
Description : Required. The resource name of the entitlement.
Pattern : ^providers/[^/]+/entitlements/[^/]+$
Required : Yes
Type : string
Location : path
Flat Path : v1/providers/{providersId}/entitlements/{entitlementsId}:rejectPlanChange
HTTP Method : POST
Parameter Order : name
▼ ▲ cloudcommerceprocurement.providers.entitlements.patch
Parameter Order : name
HTTP Method : PATCH
Parameters :
name
Description : Required. The name of the entitlement to update.
Type : string
Required : Yes
Location : path
Pattern : ^providers/[^/]+/entitlements/[^/]+$
updateMask
Type : string
Location : query
Description : The update mask that applies to the resource. See the [FieldMask definition] (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask) for more details.
Format : google-fieldmask
Path : v1/{+name}
Description : Updates an existing Entitlement.
Flat Path : v1/providers/{providersId}/entitlements/{entitlementsId}
▼ ▲ cloudcommerceprocurement.providers.entitlements.get
HTTP Method : GET
Parameter Order : name
Path : v1/{+name}
Description : Gets a requested Entitlement resource.
Parameters :
name
Required : Yes
Location : path
Pattern : ^providers/[^/]+/entitlements/[^/]+$
Type : string
Description : Required. The name of the entitlement to retrieve.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/providers/{providersId}/entitlements/{entitlementsId}
▼ ▲ cloudcommerceprocurement.providers.entitlements.reject
HTTP Method : POST
Path : v1/{+name}:reject
Parameter Order : name
Flat Path : v1/providers/{providersId}/entitlements/{entitlementsId}:reject
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : 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.
Parameters :
name
Pattern : ^providers/[^/]+/entitlements/[^/]+$
Location : path
Description : Required. The resource name of the entitlement.
Required : Yes
Type : string
▼ ▲ cloudcommerceprocurement.providers.entitlements.suspend
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Requests suspension of an active Entitlement. This is not yet supported.
HTTP Method : POST
Flat Path : v1/providers/{providersId}/entitlements/{entitlementsId}:suspend
Path : v1/{+name}:suspend
Parameters :
name
Location : path
Type : string
Pattern : ^providers/[^/]+/entitlements/[^/]+$
Description : Required. The name of the entitlement to suspend.
Required : Yes
Parameter Order : name
▼ ▲ cloudcommerceprocurement.providers.entitlements.list
Path : v1/{+parent}/entitlements
Parameter Order : parent
Flat Path : v1/providers/{providersId}/entitlements
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
filter
Location : query
Type : string
Description : The filter that can be used to limit the list request. The filter is a query string that can match a selected set of attributes with string values. For example `account=E-1234-5678-ABCD-EFGH`, `state=pending_cancellation`, and `plan!=foo-plan`. Supported query attributes are * `account` * `customer_billing_account` with value in the format of: `billingAccounts/{id}` * `product_external_name` * `quote_external_name` * `offer` * `new_pending_offer` * `plan` * `newPendingPlan` or `new_pending_plan` * `state` * `consumers.project` * `change_history.new_offer` Note that the consumers and change_history.new_offer match works on repeated structures, so equality (`consumers.project=projects/123456789`) is not supported. Set membership can be expressed with the `:` operator. For example, `consumers.project:projects/123456789` finds entitlements with at least one consumer with project field equal to `projects/123456789`. `change_history.new_offer` retrieves all entitlements that were once associated or are currently active with the offer. Also note that the state name match is case-insensitive and query can omit the prefix "ENTITLEMENT_". For example, `state=active` is equivalent to `state=ENTITLEMENT_ACTIVE`. If the query contains some special characters other than letters, underscore, or digits, the phrase must be quoted with double quotes. For example, `product="providerId:productId"`, where the product name needs to be quoted because it contains special character colon. Queries can be combined with `AND`, `OR`, and `NOT` to form more complex queries. They can also be grouped to force a desired evaluation order. For example, `state=active AND (account=E-1234 OR account=5678) AND NOT (product=foo-product)`. Connective `AND` can be omitted between two predicates. For example `account=E-1234 state=active` is equivalent to `account=E-1234 AND state=active`.
parent
Description : Required. The parent resource name.
Location : path
Type : string
Pattern : ^providers/[^/]+$
Required : Yes
pageSize
Type : integer
Description : The maximum number of entries that are requested. The default page size is 200.
Location : query
Format : int32
pageToken
Description : The token for fetching the next page.
Location : query
Type : string
HTTP Method : GET
Description : Lists Entitlements for which the provider has read access.
▼ ▲ cloudcommerceprocurement.providers.entitlements.approvePlanChange
Parameter Order : name
Flat Path : v1/providers/{providersId}/entitlements/{entitlementsId}:approvePlanChange
Description : 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.
Path : v1/{+name}:approvePlanChange
HTTP Method : POST
Parameters :
name
Pattern : ^providers/[^/]+/entitlements/[^/]+$
Location : path
Description : Required. The resource name of the entitlement.
Required : Yes
Type : string
▼ ▲ cloudcommerceprocurement.providers.entitlements.approve
HTTP Method : POST
Description : 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.
Path : v1/{+name}:approve
Parameters :
name
Location : path
Required : Yes
Type : string
Pattern : ^providers/[^/]+/entitlements/[^/]+$
Description : Required. The resource name of the entitlement, with the format `providers/{providerId}/entitlements/{entitlementId}`.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Flat Path : v1/providers/{providersId}/entitlements/{entitlementsId}:approve