Interface AccountsServiceGrpc.AsyncService (0.8.0)

public static interface AccountsServiceGrpc.AsyncService

Service to support Accounts API.

Methods

createAndConfigureAccount(CreateAndConfigureAccountRequest request, StreamObserver<Account> responseObserver)

public default void createAndConfigureAccount(CreateAndConfigureAccountRequest request, StreamObserver<Account> responseObserver)

Creates a standalone Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account.

Parameters
Name Description
request CreateAndConfigureAccountRequest
responseObserver io.grpc.stub.StreamObserver<Account>

deleteAccount(DeleteAccountRequest request, StreamObserver<Empty> responseObserver)

public default void deleteAccount(DeleteAccountRequest request, StreamObserver<Empty> responseObserver)

Deletes the specified account regardless of its type: standalone, MCA or sub-account. Deleting an MCA leads to the deletion of all of its sub-accounts. Executing this method requires admin access. The deletion succeeds only if the account does not provide services to any other account and has no processed offers. You can use the force parameter to override this.

Parameters
Name Description
request DeleteAccountRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

getAccount(GetAccountRequest request, StreamObserver<Account> responseObserver)

public default void getAccount(GetAccountRequest request, StreamObserver<Account> responseObserver)

Retrieves an account from your Merchant Center account. After inserting, updating, or deleting an account, it may take several minutes before changes take effect.

Parameters
Name Description
request GetAccountRequest
responseObserver io.grpc.stub.StreamObserver<Account>

listAccounts(ListAccountsRequest request, StreamObserver<ListAccountsResponse> responseObserver)

public default void listAccounts(ListAccountsRequest request, StreamObserver<ListAccountsResponse> responseObserver)

Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on. If no filter is provided, then it returns accounts the user is directly added to.

Parameters
Name Description
request ListAccountsRequest
responseObserver io.grpc.stub.StreamObserver<ListAccountsResponse>

listSubAccounts(ListSubAccountsRequest request, StreamObserver<ListSubAccountsResponse> responseObserver)

public default void listSubAccounts(ListSubAccountsRequest request, StreamObserver<ListSubAccountsResponse> responseObserver)

List all sub-accounts for a given multi client account. This is a convenience wrapper for the more powerful ListAccounts method. This method will produce the same results as calling ListsAccounts with the following filter: relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION"))

Parameters
Name Description
request ListSubAccountsRequest
responseObserver io.grpc.stub.StreamObserver<ListSubAccountsResponse>

updateAccount(UpdateAccountRequest request, StreamObserver<Account> responseObserver)

public default void updateAccount(UpdateAccountRequest request, StreamObserver<Account> responseObserver)

Updates an account regardless of its type: standalone, MCA or sub-account. Executing this method requires admin access.

Parameters
Name Description
request UpdateAccountRequest
responseObserver io.grpc.stub.StreamObserver<Account>