class BuyersClientsUsers extends Resource (View source)

The "users" collection of methods.

Typical usage is:

 $authorizedbuyersmarketplaceService = new Google\Service\AuthorizedBuyersMarketplace(...);
 $users = $authorizedbuyersmarketplaceService->buyers_clients_users;

Methods

activate(string $name, ActivateClientUserRequest $postBody, array $optParams = [])

Activates an existing client user. The state of the client user will be updated from "INACTIVE" to "ACTIVE". This method has no effect if the client user is already in "ACTIVE" state. An error will be returned if the client user to activate is still in "INVITED" state. (users.activate)

create(string $parent, ClientUser $postBody, array $optParams = [])

Creates a new client user in "INVITED" state. An email invitation will be sent to the new user, once accepted the user will become active.

deactivate(string $name, DeactivateClientUserRequest $postBody, array $optParams = [])

Deactivates an existing client user. The state of the client user will be updated from "ACTIVE" to "INACTIVE". This method has no effect if the client user is already in "INACTIVE" state. An error will be returned if the client user to deactivate is still in "INVITED" state. (users.deactivate)

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

Deletes an existing client user. The client user will lose access to the Authorized Buyers UI. Note that if a client user is deleted, the user's access to the UI can't be restored unless a new client user is created and activated. (users.delete)

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

Retrieves an existing client user. (users.get)

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

Lists all client users for a specified client. (users.listBuyersClientsUsers)

Details

ClientUser activate(string $name, ActivateClientUserRequest $postBody, array $optParams = [])

Activates an existing client user. The state of the client user will be updated from "INACTIVE" to "ACTIVE". This method has no effect if the client user is already in "ACTIVE" state. An error will be returned if the client user to activate is still in "INVITED" state. (users.activate)

Parameters

string $name

Required. Format: buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}

ActivateClientUserRequest $postBody
array $optParams

Optional parameters.

Return Value

ClientUser

Exceptions

Exception

ClientUser create(string $parent, ClientUser $postBody, array $optParams = [])

Creates a new client user in "INVITED" state. An email invitation will be sent to the new user, once accepted the user will become active.

(users.create)

Parameters

string $parent

Required. The name of the client. Format: buyers/{accountId}/clients/{clientAccountId}

ClientUser $postBody
array $optParams

Optional parameters.

Return Value

ClientUser

Exceptions

Exception

ClientUser deactivate(string $name, DeactivateClientUserRequest $postBody, array $optParams = [])

Deactivates an existing client user. The state of the client user will be updated from "ACTIVE" to "INACTIVE". This method has no effect if the client user is already in "INACTIVE" state. An error will be returned if the client user to deactivate is still in "INVITED" state. (users.deactivate)

Parameters

string $name

Required. Format: buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}

DeactivateClientUserRequest $postBody
array $optParams

Optional parameters.

Return Value

ClientUser

Exceptions

Exception

AuthorizedbuyersmarketplaceEmpty delete(string $name, array $optParams = [])

Deletes an existing client user. The client user will lose access to the Authorized Buyers UI. Note that if a client user is deleted, the user's access to the UI can't be restored unless a new client user is created and activated. (users.delete)

Parameters

string $name

Required. Format: buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}

array $optParams

Optional parameters.

Return Value

AuthorizedbuyersmarketplaceEmpty

Exceptions

Exception

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

Retrieves an existing client user. (users.get)

Parameters

string $name

Required. Format: buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}

array $optParams

Optional parameters.

Return Value

ClientUser

Exceptions

Exception

ListClientUsersResponse listBuyersClientsUsers(string $parent, array $optParams = [])

Lists all client users for a specified client. (users.listBuyersClientsUsers)

Parameters

string $parent

Required. The name of the client. Format: buyers/{buyerAccountId}/clients/{clientAccountId}

array $optParams

Optional parameters.

Return Value

ListClientUsersResponse

Exceptions

Exception