Class NotificationsApiServiceGrpc.NotificationsApiServiceBlockingV2Stub (1.0.0)

public static final class NotificationsApiServiceGrpc.NotificationsApiServiceBlockingV2Stub extends AbstractBlockingStub<NotificationsApiServiceGrpc.NotificationsApiServiceBlockingV2Stub>

A stub to allow clients to do synchronous rpc calls to service NotificationsApiService.

Service to manage notification subscriptions for merchants

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > NotificationsApiServiceGrpc.NotificationsApiServiceBlockingV2Stub

Methods

build(Channel channel, CallOptions callOptions)

protected NotificationsApiServiceGrpc.NotificationsApiServiceBlockingV2Stub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
NotificationsApiServiceGrpc.NotificationsApiServiceBlockingV2Stub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createNotificationSubscription(CreateNotificationSubscriptionRequest request)

public NotificationSubscription createNotificationSubscription(CreateNotificationSubscriptionRequest request)

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):

  1. Subscription for all managed accounts + subscription for self.
  2. Multiple "partial" subscriptions for managed accounts + subscription for self. we will not allow (per business as a subscriber per event type):
  3. Multiple self subscriptions.
  4. Multiple "all managed accounts" subscriptions.
  5. "All managed accounts" subscription and partial subscriptions at the same time.
  6. Multiple partial subscriptions for the same target account.
Parameter
Name Description
request CreateNotificationSubscriptionRequest
Returns
Type Description
NotificationSubscription

deleteNotificationSubscription(DeleteNotificationSubscriptionRequest request)

public Empty deleteNotificationSubscription(DeleteNotificationSubscriptionRequest request)

Deletes a notification subscription for a merchant.

Parameter
Name Description
request DeleteNotificationSubscriptionRequest
Returns
Type Description
Empty

getNotificationSubscription(GetNotificationSubscriptionRequest request)

public NotificationSubscription getNotificationSubscription(GetNotificationSubscriptionRequest request)

Gets notification subscriptions for an account.

Parameter
Name Description
request GetNotificationSubscriptionRequest
Returns
Type Description
NotificationSubscription

getNotificationSubscriptionHealthMetrics(GetNotificationSubscriptionHealthMetricsRequest request)

public NotificationSubscriptionHealthMetrics getNotificationSubscriptionHealthMetrics(GetNotificationSubscriptionHealthMetricsRequest request)

Retrieves notification subscription health metrics for a merchant. We recommend calling this periodically (hourly or daily) to monitor health of your callback endpoint.

Parameter
Name Description
request GetNotificationSubscriptionHealthMetricsRequest
Returns
Type Description
NotificationSubscriptionHealthMetrics

listNotificationSubscriptions(ListNotificationSubscriptionsRequest request)

public ListNotificationSubscriptionsResponse listNotificationSubscriptions(ListNotificationSubscriptionsRequest request)

Gets all the notification subscriptions for a merchant.

Parameter
Name Description
request ListNotificationSubscriptionsRequest
Returns
Type Description
ListNotificationSubscriptionsResponse

updateNotificationSubscription(UpdateNotificationSubscriptionRequest request)

public NotificationSubscription updateNotificationSubscription(UpdateNotificationSubscriptionRequest request)

Updates an existing notification subscription for a merchant.

Parameter
Name Description
request UpdateNotificationSubscriptionRequest
Returns
Type Description
NotificationSubscription