public static final class NotificationsApiServiceGrpc.NotificationsApiServiceStub extends AbstractAsyncStub<NotificationsApiServiceGrpc.NotificationsApiServiceStub>A stub to allow clients to do asynchronous rpc calls to service NotificationsApiService.
Service to manage notification subscriptions for merchants
Inheritance
java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractAsyncStub > NotificationsApiServiceGrpc.NotificationsApiServiceStubMethods
build(Channel channel, CallOptions callOptions)
protected NotificationsApiServiceGrpc.NotificationsApiServiceStub build(Channel channel, CallOptions callOptions)| Parameters | |
|---|---|
| Name | Description |
channel |
io.grpc.Channel |
callOptions |
io.grpc.CallOptions |
| Returns | |
|---|---|
| Type | Description |
NotificationsApiServiceGrpc.NotificationsApiServiceStub |
|
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
createNotificationSubscription(CreateNotificationSubscriptionRequest request, StreamObserver<NotificationSubscription> responseObserver)
public void createNotificationSubscription(CreateNotificationSubscriptionRequest request, StreamObserver<NotificationSubscription> responseObserver)Creates a notification subscription for a business. For standalone or subaccounts accounts, the business can create a subscription for self. For MCAs, the business can create a subscription for all managed accounts or for a specific subaccount. We will allow the following types of notification subscriptions to exist together (per business as a subscriber per event type):
- Subscription for all managed accounts + subscription for self.
- Multiple "partial" subscriptions for managed accounts + subscription for self. we will not allow (per business as a subscriber per event type):
- Multiple self subscriptions.
- Multiple "all managed accounts" subscriptions.
- "All managed accounts" subscription and partial subscriptions at the same time.
- Multiple partial subscriptions for the same target account.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateNotificationSubscriptionRequest |
responseObserver |
io.grpc.stub.StreamObserver<NotificationSubscription> |
deleteNotificationSubscription(DeleteNotificationSubscriptionRequest request, StreamObserver<Empty> responseObserver)
public void deleteNotificationSubscription(DeleteNotificationSubscriptionRequest request, StreamObserver<Empty> responseObserver)Deletes a notification subscription for a merchant.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteNotificationSubscriptionRequest |
responseObserver |
io.grpc.stub.StreamObserver<Empty> |
getNotificationSubscription(GetNotificationSubscriptionRequest request, StreamObserver<NotificationSubscription> responseObserver)
public void getNotificationSubscription(GetNotificationSubscriptionRequest request, StreamObserver<NotificationSubscription> responseObserver)Gets notification subscriptions for an account.
| Parameters | |
|---|---|
| Name | Description |
request |
GetNotificationSubscriptionRequest |
responseObserver |
io.grpc.stub.StreamObserver<NotificationSubscription> |
getNotificationSubscriptionHealthMetrics(GetNotificationSubscriptionHealthMetricsRequest request, StreamObserver<NotificationSubscriptionHealthMetrics> responseObserver)
public void getNotificationSubscriptionHealthMetrics(GetNotificationSubscriptionHealthMetricsRequest request, StreamObserver<NotificationSubscriptionHealthMetrics> responseObserver)Retrieves notification subscription health metrics for a merchant. We recommend calling this periodically (hourly or daily) to monitor health of your callback endpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
GetNotificationSubscriptionHealthMetricsRequest |
responseObserver |
io.grpc.stub.StreamObserver<NotificationSubscriptionHealthMetrics> |
listNotificationSubscriptions(ListNotificationSubscriptionsRequest request, StreamObserver<ListNotificationSubscriptionsResponse> responseObserver)
public void listNotificationSubscriptions(ListNotificationSubscriptionsRequest request, StreamObserver<ListNotificationSubscriptionsResponse> responseObserver)Gets all the notification subscriptions for a merchant.
| Parameters | |
|---|---|
| Name | Description |
request |
ListNotificationSubscriptionsRequest |
responseObserver |
io.grpc.stub.StreamObserver<ListNotificationSubscriptionsResponse> |
updateNotificationSubscription(UpdateNotificationSubscriptionRequest request, StreamObserver<NotificationSubscription> responseObserver)
public void updateNotificationSubscription(UpdateNotificationSubscriptionRequest request, StreamObserver<NotificationSubscription> responseObserver)Updates an existing notification subscription for a merchant.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateNotificationSubscriptionRequest |
responseObserver |
io.grpc.stub.StreamObserver<NotificationSubscription> |