Package cloud.google.com/go/shopping/merchant/notifications/apiv1/notificationspb (v1.2.1)

Version latest

• 1.2.1 (latest)
• 1.2.0
• 1.1.1
• 1.0.0
• 0.25.0
• 0.24.1
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.1
• 0.18.1
• 0.17.1
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.1
• 0.11.1
• 0.10.0
• 0.9.2
• 0.8.7
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.2
• 0.2.2

Note: To get more information about this package, such as access to older versions, view this package on pkg.go.dev.

Constants

NotificationsApiService_GetNotificationSubscription_FullMethodName, NotificationsApiService_CreateNotificationSubscription_FullMethodName, NotificationsApiService_UpdateNotificationSubscription_FullMethodName, NotificationsApiService_DeleteNotificationSubscription_FullMethodName, NotificationsApiService_ListNotificationSubscriptions_FullMethodName, NotificationsApiService_GetNotificationSubscriptionHealthMetrics_FullMethodName

const (
	NotificationsApiService_GetNotificationSubscription_FullMethodName              = "/google.shopping.merchant.notifications.v1.NotificationsApiService/GetNotificationSubscription"
	NotificationsApiService_CreateNotificationSubscription_FullMethodName           = "/google.shopping.merchant.notifications.v1.NotificationsApiService/CreateNotificationSubscription"
	NotificationsApiService_UpdateNotificationSubscription_FullMethodName           = "/google.shopping.merchant.notifications.v1.NotificationsApiService/UpdateNotificationSubscription"
	NotificationsApiService_DeleteNotificationSubscription_FullMethodName           = "/google.shopping.merchant.notifications.v1.NotificationsApiService/DeleteNotificationSubscription"
	NotificationsApiService_ListNotificationSubscriptions_FullMethodName            = "/google.shopping.merchant.notifications.v1.NotificationsApiService/ListNotificationSubscriptions"
	NotificationsApiService_GetNotificationSubscriptionHealthMetrics_FullMethodName = "/google.shopping.merchant.notifications.v1.NotificationsApiService/GetNotificationSubscriptionHealthMetrics"
)

Variables

NotificationSubscription_NotificationEventType_name, NotificationSubscription_NotificationEventType_value

var (
	NotificationSubscription_NotificationEventType_name = map[int32]string{
		0: "NOTIFICATION_EVENT_TYPE_UNSPECIFIED",
		1: "PRODUCT_STATUS_CHANGE",
	}
	NotificationSubscription_NotificationEventType_value = map[string]int32{
		"NOTIFICATION_EVENT_TYPE_UNSPECIFIED": 0,
		"PRODUCT_STATUS_CHANGE":               1,
	}
)

Enum value maps for NotificationSubscription_NotificationEventType.

File_google_shopping_merchant_notifications_v1_notificationsapi_proto

var File_google_shopping_merchant_notifications_v1_notificationsapi_proto protoreflect.FileDescriptor

NotificationsApiService_ServiceDesc

var NotificationsApiService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.shopping.merchant.notifications.v1.NotificationsApiService",
	HandlerType: (*NotificationsApiServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetNotificationSubscription",
			Handler:    _NotificationsApiService_GetNotificationSubscription_Handler,
		},
		{
			MethodName: "CreateNotificationSubscription",
			Handler:    _NotificationsApiService_CreateNotificationSubscription_Handler,
		},
		{
			MethodName: "UpdateNotificationSubscription",
			Handler:    _NotificationsApiService_UpdateNotificationSubscription_Handler,
		},
		{
			MethodName: "DeleteNotificationSubscription",
			Handler:    _NotificationsApiService_DeleteNotificationSubscription_Handler,
		},
		{
			MethodName: "ListNotificationSubscriptions",
			Handler:    _NotificationsApiService_ListNotificationSubscriptions_Handler,
		},
		{
			MethodName: "GetNotificationSubscriptionHealthMetrics",
			Handler:    _NotificationsApiService_GetNotificationSubscriptionHealthMetrics_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/shopping/merchant/notifications/v1/notificationsapi.proto",
}

NotificationsApiService_ServiceDesc is the grpc.ServiceDesc for NotificationsApiService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterNotificationsApiServiceServer

func RegisterNotificationsApiServiceServer(s grpc.ServiceRegistrar, srv NotificationsApiServiceServer)

CreateNotificationSubscriptionRequest

type CreateNotificationSubscriptionRequest struct {

	// Required. The merchant account that owns the new notification subscription.
	// Format: `accounts/{account}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The notification subscription to create.
	NotificationSubscription *NotificationSubscription `protobuf:"bytes,2,opt,name=notification_subscription,json=notificationSubscription,proto3" json:"notification_subscription,omitempty"`
	// contains filtered or unexported fields
}

Request message for the CreateNotificationSubscription method.

func (*CreateNotificationSubscriptionRequest) Descriptor

func (*CreateNotificationSubscriptionRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateNotificationSubscriptionRequest.ProtoReflect.Descriptor instead.

func (*CreateNotificationSubscriptionRequest) GetNotificationSubscription

func (x *CreateNotificationSubscriptionRequest) GetNotificationSubscription() *NotificationSubscription

func (*CreateNotificationSubscriptionRequest) GetParent

func (x *CreateNotificationSubscriptionRequest) GetParent() string

func (*CreateNotificationSubscriptionRequest) ProtoMessage

func (*CreateNotificationSubscriptionRequest) ProtoMessage()

func (*CreateNotificationSubscriptionRequest) ProtoReflect

func (x *CreateNotificationSubscriptionRequest) ProtoReflect() protoreflect.Message

func (*CreateNotificationSubscriptionRequest) Reset

func (x *CreateNotificationSubscriptionRequest) Reset()

func (*CreateNotificationSubscriptionRequest) String

func (x *CreateNotificationSubscriptionRequest) String() string

DeleteNotificationSubscriptionRequest

type DeleteNotificationSubscriptionRequest struct {

	// Required. The name of the notification subscription to be deleted.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for the DeleteNotificationSubscription method.

func (*DeleteNotificationSubscriptionRequest) Descriptor

func (*DeleteNotificationSubscriptionRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteNotificationSubscriptionRequest.ProtoReflect.Descriptor instead.

func (*DeleteNotificationSubscriptionRequest) GetName

func (x *DeleteNotificationSubscriptionRequest) GetName() string

func (*DeleteNotificationSubscriptionRequest) ProtoMessage

func (*DeleteNotificationSubscriptionRequest) ProtoMessage()

func (*DeleteNotificationSubscriptionRequest) ProtoReflect

func (x *DeleteNotificationSubscriptionRequest) ProtoReflect() protoreflect.Message

func (*DeleteNotificationSubscriptionRequest) Reset

func (x *DeleteNotificationSubscriptionRequest) Reset()

func (*DeleteNotificationSubscriptionRequest) String

func (x *DeleteNotificationSubscriptionRequest) String() string

GetNotificationSubscriptionHealthMetricsRequest

type GetNotificationSubscriptionHealthMetricsRequest struct {

	// Required. The `name` of the notification subscription for which metrics are
	// retrieved.
	// Format:
	// `accounts/{account}/notificationsubscriptions/{notification_subscription}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for notification subscription health metrics.

func (*GetNotificationSubscriptionHealthMetricsRequest) Descriptor

func (*GetNotificationSubscriptionHealthMetricsRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetNotificationSubscriptionHealthMetricsRequest.ProtoReflect.Descriptor instead.

func (*GetNotificationSubscriptionHealthMetricsRequest) GetName

func (x *GetNotificationSubscriptionHealthMetricsRequest) GetName() string

func (*GetNotificationSubscriptionHealthMetricsRequest) ProtoMessage

func (*GetNotificationSubscriptionHealthMetricsRequest) ProtoMessage()

func (*GetNotificationSubscriptionHealthMetricsRequest) ProtoReflect

func (x *GetNotificationSubscriptionHealthMetricsRequest) ProtoReflect() protoreflect.Message

func (*GetNotificationSubscriptionHealthMetricsRequest) Reset

func (x *GetNotificationSubscriptionHealthMetricsRequest) Reset()

func (*GetNotificationSubscriptionHealthMetricsRequest) String

func (x *GetNotificationSubscriptionHealthMetricsRequest) String() string

GetNotificationSubscriptionRequest

type GetNotificationSubscriptionRequest struct {

	// Required. The `name` of the notification subscription.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for the GetNotificationSubscription method.

func (*GetNotificationSubscriptionRequest) Descriptor

func (*GetNotificationSubscriptionRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetNotificationSubscriptionRequest.ProtoReflect.Descriptor instead.

func (*GetNotificationSubscriptionRequest) GetName

func (x *GetNotificationSubscriptionRequest) GetName() string

func (*GetNotificationSubscriptionRequest) ProtoMessage

func (*GetNotificationSubscriptionRequest) ProtoMessage()

func (*GetNotificationSubscriptionRequest) ProtoReflect

func (x *GetNotificationSubscriptionRequest) ProtoReflect() protoreflect.Message

func (*GetNotificationSubscriptionRequest) Reset

func (x *GetNotificationSubscriptionRequest) Reset()

func (*GetNotificationSubscriptionRequest) String

func (x *GetNotificationSubscriptionRequest) String() string

ListNotificationSubscriptionsRequest

type ListNotificationSubscriptionsRequest struct {

	// Required. The merchant account who owns the notification subscriptions.
	// Format: `accounts/{account}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of notification subscriptions to return in a page.
	// The default value for `page_size` is 100. The
	// maximum value is `200`. Values above `200` will be coerced to `200`.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Token (if provided) to retrieve the subsequent page. All other parameters
	// must match the original call that provided the page token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for the ListNotificationSubscription method.

func (*ListNotificationSubscriptionsRequest) Descriptor

func (*ListNotificationSubscriptionsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListNotificationSubscriptionsRequest.ProtoReflect.Descriptor instead.

func (*ListNotificationSubscriptionsRequest) GetPageSize

func (x *ListNotificationSubscriptionsRequest) GetPageSize() int32

func (*ListNotificationSubscriptionsRequest) GetPageToken

func (x *ListNotificationSubscriptionsRequest) GetPageToken() string

func (*ListNotificationSubscriptionsRequest) GetParent

func (x *ListNotificationSubscriptionsRequest) GetParent() string

func (*ListNotificationSubscriptionsRequest) ProtoMessage

func (*ListNotificationSubscriptionsRequest) ProtoMessage()

func (*ListNotificationSubscriptionsRequest) ProtoReflect

func (x *ListNotificationSubscriptionsRequest) ProtoReflect() protoreflect.Message

func (*ListNotificationSubscriptionsRequest) Reset

func (x *ListNotificationSubscriptionsRequest) Reset()

func (*ListNotificationSubscriptionsRequest) String

func (x *ListNotificationSubscriptionsRequest) String() string

ListNotificationSubscriptionsResponse

type ListNotificationSubscriptionsResponse struct {

	// The list of notification subscriptions requested by the merchant.
	NotificationSubscriptions []*NotificationSubscription `protobuf:"bytes,1,rep,name=notification_subscriptions,json=notificationSubscriptions,proto3" json:"notification_subscriptions,omitempty"`
	// A token, which can be sent as `page_token` to retrieve the next page.
	// If this field is omitted, there are no subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for the ListNotificationSubscription method.

func (*ListNotificationSubscriptionsResponse) Descriptor

func (*ListNotificationSubscriptionsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListNotificationSubscriptionsResponse.ProtoReflect.Descriptor instead.

func (*ListNotificationSubscriptionsResponse) GetNextPageToken

func (x *ListNotificationSubscriptionsResponse) GetNextPageToken() string

func (*ListNotificationSubscriptionsResponse) GetNotificationSubscriptions

func (x *ListNotificationSubscriptionsResponse) GetNotificationSubscriptions() []*NotificationSubscription

func (*ListNotificationSubscriptionsResponse) ProtoMessage

func (*ListNotificationSubscriptionsResponse) ProtoMessage()

func (*ListNotificationSubscriptionsResponse) ProtoReflect

func (x *ListNotificationSubscriptionsResponse) ProtoReflect() protoreflect.Message

func (*ListNotificationSubscriptionsResponse) Reset

func (x *ListNotificationSubscriptionsResponse) Reset()

func (*ListNotificationSubscriptionsResponse) String

func (x *ListNotificationSubscriptionsResponse) String() string

NotificationSubscription

type NotificationSubscription struct {

	// Types that are assignable to InterestedIn:
	//
	//	*NotificationSubscription_AllManagedAccounts
	//	*NotificationSubscription_TargetAccount
	InterestedIn isNotificationSubscription_InterestedIn `protobuf_oneof:"interested_in"`
	// Output only. The `name` of the notification configuration. Generated by the
	// Content API upon creation of a new `NotificationSubscription`. The
	// `account` represents the merchant ID of the merchant that owns the
	// configuration. Format:
	// `accounts/{account}/notificationsubscriptions/{notification_subscription}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The event that the merchant wants to be notified about.
	RegisteredEvent NotificationSubscription_NotificationEventType `protobuf:"varint,2,opt,name=registered_event,json=registeredEvent,proto3,enum=google.shopping.merchant.notifications.v1.NotificationSubscription_NotificationEventType" json:"registered_event,omitempty"`
	// URL to be used to push the notification to the merchant.
	CallBackUri string `protobuf:"bytes,5,opt,name=call_back_uri,json=callBackUri,proto3" json:"call_back_uri,omitempty"`
	// contains filtered or unexported fields
}

Represents a notification subscription owned by a Merchant account.

func (*NotificationSubscription) Descriptor

func (*NotificationSubscription) Descriptor() ([]byte, []int)

Deprecated: Use NotificationSubscription.ProtoReflect.Descriptor instead.

func (*NotificationSubscription) GetAllManagedAccounts

func (x *NotificationSubscription) GetAllManagedAccounts() bool

func (*NotificationSubscription) GetCallBackUri

func (x *NotificationSubscription) GetCallBackUri() string

func (*NotificationSubscription) GetInterestedIn

func (m *NotificationSubscription) GetInterestedIn() isNotificationSubscription_InterestedIn

func (*NotificationSubscription) GetName

func (x *NotificationSubscription) GetName() string

func (*NotificationSubscription) GetRegisteredEvent

func (x *NotificationSubscription) GetRegisteredEvent() NotificationSubscription_NotificationEventType

func (*NotificationSubscription) GetTargetAccount

func (x *NotificationSubscription) GetTargetAccount() string

func (*NotificationSubscription) ProtoMessage

func (*NotificationSubscription) ProtoMessage()

func (*NotificationSubscription) ProtoReflect

func (x *NotificationSubscription) ProtoReflect() protoreflect.Message

func (*NotificationSubscription) Reset

func (x *NotificationSubscription) Reset()

func (*NotificationSubscription) String

func (x *NotificationSubscription) String() string

NotificationSubscriptionHealthMetrics

type NotificationSubscriptionHealthMetrics struct {

	// Output only. Identifier. The name of the notification configuration.
	// Generated by the Content API upon creation of a new
	// NotificationSubscription. The account represents the merchant ID of the
	// merchant that owns the configuration.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The number of retained acknowledged messages for the last 24 hours
	AcknowledgedMessagesCount int64 `protobuf:"varint,2,opt,name=acknowledged_messages_count,json=acknowledgedMessagesCount,proto3" json:"acknowledged_messages_count,omitempty"`
	// The number of unacknowledged messages for the last 7 days, we will attempt
	// to re-deliver the unacknowledged message later and once successfully
	// delivered it will not be counted within unacknowledged messages (the number
	// of unacknowledged messages should gradually decrease to zero once the issue
	// is fixed).
	UndeliveredMessagesCount int64 `protobuf:"varint,3,opt,name=undelivered_messages_count,json=undeliveredMessagesCount,proto3" json:"undelivered_messages_count,omitempty"`
	// The time since the oldest unacknowledged message was sent in seconds
	OldestUnacknowledgedMessageWaitingTime int64 `protobuf:"varint,4,opt,name=oldest_unacknowledged_message_waiting_time,json=oldestUnacknowledgedMessageWaitingTime,proto3" json:"oldest_unacknowledged_message_waiting_time,omitempty"`
	// contains filtered or unexported fields
}

Represents a notification subscription health metrics.

func (*NotificationSubscriptionHealthMetrics) Descriptor

func (*NotificationSubscriptionHealthMetrics) Descriptor() ([]byte, []int)

Deprecated: Use NotificationSubscriptionHealthMetrics.ProtoReflect.Descriptor instead.

func (*NotificationSubscriptionHealthMetrics) GetAcknowledgedMessagesCount

func (x *NotificationSubscriptionHealthMetrics) GetAcknowledgedMessagesCount() int64

func (*NotificationSubscriptionHealthMetrics) GetName

func (x *NotificationSubscriptionHealthMetrics) GetName() string

func (*NotificationSubscriptionHealthMetrics) GetOldestUnacknowledgedMessageWaitingTime

func (x *NotificationSubscriptionHealthMetrics) GetOldestUnacknowledgedMessageWaitingTime() int64

func (*NotificationSubscriptionHealthMetrics) GetUndeliveredMessagesCount

func (x *NotificationSubscriptionHealthMetrics) GetUndeliveredMessagesCount() int64

func (*NotificationSubscriptionHealthMetrics) ProtoMessage

func (*NotificationSubscriptionHealthMetrics) ProtoMessage()

func (*NotificationSubscriptionHealthMetrics) ProtoReflect

func (x *NotificationSubscriptionHealthMetrics) ProtoReflect() protoreflect.Message

func (*NotificationSubscriptionHealthMetrics) Reset

func (x *NotificationSubscriptionHealthMetrics) Reset()

func (*NotificationSubscriptionHealthMetrics) String

func (x *NotificationSubscriptionHealthMetrics) String() string

NotificationSubscription_AllManagedAccounts

type NotificationSubscription_AllManagedAccounts struct {
	// If this value is true, the requesting account is notified of the
	// specified event for all managed accounts (can be subaccounts or other
	// linked accounts) including newly added accounts on a daily basis.
	AllManagedAccounts bool `protobuf:"varint,3,opt,name=all_managed_accounts,json=allManagedAccounts,proto3,oneof"`
}

NotificationSubscription_NotificationEventType

type NotificationSubscription_NotificationEventType int32

Represents the event type that the merchant is interested in receiving notifications for.

NotificationSubscription_NOTIFICATION_EVENT_TYPE_UNSPECIFIED, NotificationSubscription_PRODUCT_STATUS_CHANGE

const (
	// Notifications event type is unspecified.
	NotificationSubscription_NOTIFICATION_EVENT_TYPE_UNSPECIFIED NotificationSubscription_NotificationEventType = 0
	// Notification of product status changes, for example when product becomes
	// disapproved.
	NotificationSubscription_PRODUCT_STATUS_CHANGE NotificationSubscription_NotificationEventType = 1
)

func (NotificationSubscription_NotificationEventType) Descriptor

func (NotificationSubscription_NotificationEventType) Descriptor() protoreflect.EnumDescriptor

func (NotificationSubscription_NotificationEventType) Enum

func (x NotificationSubscription_NotificationEventType) Enum() *NotificationSubscription_NotificationEventType

func (NotificationSubscription_NotificationEventType) EnumDescriptor

func (NotificationSubscription_NotificationEventType) EnumDescriptor() ([]byte, []int)

Deprecated: Use NotificationSubscription_NotificationEventType.Descriptor instead.

func (NotificationSubscription_NotificationEventType) Number

func (x NotificationSubscription_NotificationEventType) Number() protoreflect.EnumNumber

func (NotificationSubscription_NotificationEventType) String

func (x NotificationSubscription_NotificationEventType) String() string

func (NotificationSubscription_NotificationEventType) Type

func (NotificationSubscription_NotificationEventType) Type() protoreflect.EnumType

NotificationSubscription_TargetAccount

type NotificationSubscription_TargetAccount struct {
	// The `name` of the account you want to receive notifications for.
	// Format: `accounts/{account}`
	TargetAccount string `protobuf:"bytes,4,opt,name=target_account,json=targetAccount,proto3,oneof"`
}

NotificationsApiServiceClient

type NotificationsApiServiceClient interface {
	// Gets notification subscriptions for an account.
	GetNotificationSubscription(ctx context.Context, in *GetNotificationSubscriptionRequest, opts ...grpc.CallOption) (*NotificationSubscription, error)
	// 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):
	//
	// 1. Multiple self subscriptions.
	//
	// 2. Multiple "all managed accounts" subscriptions.
	//
	// 3. "All managed accounts" subscription and partial subscriptions at the
	// same time.
	//
	// 4. Multiple partial subscriptions for the same target account.
	CreateNotificationSubscription(ctx context.Context, in *CreateNotificationSubscriptionRequest, opts ...grpc.CallOption) (*NotificationSubscription, error)
	// Updates an existing notification subscription for a merchant.
	UpdateNotificationSubscription(ctx context.Context, in *UpdateNotificationSubscriptionRequest, opts ...grpc.CallOption) (*NotificationSubscription, error)
	// Deletes a notification subscription for a merchant.
	DeleteNotificationSubscription(ctx context.Context, in *DeleteNotificationSubscriptionRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Gets all the notification subscriptions for a merchant.
	ListNotificationSubscriptions(ctx context.Context, in *ListNotificationSubscriptionsRequest, opts ...grpc.CallOption) (*ListNotificationSubscriptionsResponse, error)
	// Retrieves notification subscription health metrics for a merchant.
	// We recommend calling this periodically (hourly or daily) to monitor health
	// of your callback endpoint.
	GetNotificationSubscriptionHealthMetrics(ctx context.Context, in *GetNotificationSubscriptionHealthMetricsRequest, opts ...grpc.CallOption) (*NotificationSubscriptionHealthMetrics, error)
}

NotificationsApiServiceClient is the client API for NotificationsApiService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewNotificationsApiServiceClient

func NewNotificationsApiServiceClient(cc grpc.ClientConnInterface) NotificationsApiServiceClient

NotificationsApiServiceServer

type NotificationsApiServiceServer interface {
	// Gets notification subscriptions for an account.
	GetNotificationSubscription(context.Context, *GetNotificationSubscriptionRequest) (*NotificationSubscription, error)
	// 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):
	//
	// 1. Multiple self subscriptions.
	//
	// 2. Multiple "all managed accounts" subscriptions.
	//
	// 3. "All managed accounts" subscription and partial subscriptions at the
	// same time.
	//
	// 4. Multiple partial subscriptions for the same target account.
	CreateNotificationSubscription(context.Context, *CreateNotificationSubscriptionRequest) (*NotificationSubscription, error)
	// Updates an existing notification subscription for a merchant.
	UpdateNotificationSubscription(context.Context, *UpdateNotificationSubscriptionRequest) (*NotificationSubscription, error)
	// Deletes a notification subscription for a merchant.
	DeleteNotificationSubscription(context.Context, *DeleteNotificationSubscriptionRequest) (*emptypb.Empty, error)
	// Gets all the notification subscriptions for a merchant.
	ListNotificationSubscriptions(context.Context, *ListNotificationSubscriptionsRequest) (*ListNotificationSubscriptionsResponse, error)
	// Retrieves notification subscription health metrics for a merchant.
	// We recommend calling this periodically (hourly or daily) to monitor health
	// of your callback endpoint.
	GetNotificationSubscriptionHealthMetrics(context.Context, *GetNotificationSubscriptionHealthMetricsRequest) (*NotificationSubscriptionHealthMetrics, error)
}

NotificationsApiServiceServer is the server API for NotificationsApiService service. All implementations should embed UnimplementedNotificationsApiServiceServer for forward compatibility

UnimplementedNotificationsApiServiceServer

type UnimplementedNotificationsApiServiceServer struct {
}

UnimplementedNotificationsApiServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedNotificationsApiServiceServer) CreateNotificationSubscription

func (UnimplementedNotificationsApiServiceServer) CreateNotificationSubscription(context.Context, *CreateNotificationSubscriptionRequest) (*NotificationSubscription, error)

func (UnimplementedNotificationsApiServiceServer) DeleteNotificationSubscription

func (UnimplementedNotificationsApiServiceServer) DeleteNotificationSubscription(context.Context, *DeleteNotificationSubscriptionRequest) (*emptypb.Empty, error)

func (UnimplementedNotificationsApiServiceServer) GetNotificationSubscription

func (UnimplementedNotificationsApiServiceServer) GetNotificationSubscription(context.Context, *GetNotificationSubscriptionRequest) (*NotificationSubscription, error)

func (UnimplementedNotificationsApiServiceServer) GetNotificationSubscriptionHealthMetrics

func (UnimplementedNotificationsApiServiceServer) GetNotificationSubscriptionHealthMetrics(context.Context, *GetNotificationSubscriptionHealthMetricsRequest) (*NotificationSubscriptionHealthMetrics, error)

func (UnimplementedNotificationsApiServiceServer) ListNotificationSubscriptions

func (UnimplementedNotificationsApiServiceServer) ListNotificationSubscriptions(context.Context, *ListNotificationSubscriptionsRequest) (*ListNotificationSubscriptionsResponse, error)

func (UnimplementedNotificationsApiServiceServer) UpdateNotificationSubscription

func (UnimplementedNotificationsApiServiceServer) UpdateNotificationSubscription(context.Context, *UpdateNotificationSubscriptionRequest) (*NotificationSubscription, error)

UnsafeNotificationsApiServiceServer

type UnsafeNotificationsApiServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeNotificationsApiServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to NotificationsApiServiceServer will result in compilation errors.

UpdateNotificationSubscriptionRequest

type UpdateNotificationSubscriptionRequest struct {

	// Required. The new version of the notification subscription that should be
	// updated.
	NotificationSubscription *NotificationSubscription `protobuf:"bytes,1,opt,name=notification_subscription,json=notificationSubscription,proto3" json:"notification_subscription,omitempty"`
	// List of fields being updated.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for the UpdateNotificationSubscription method.

func (*UpdateNotificationSubscriptionRequest) Descriptor

func (*UpdateNotificationSubscriptionRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateNotificationSubscriptionRequest.ProtoReflect.Descriptor instead.

func (*UpdateNotificationSubscriptionRequest) GetNotificationSubscription

func (x *UpdateNotificationSubscriptionRequest) GetNotificationSubscription() *NotificationSubscription

func (*UpdateNotificationSubscriptionRequest) GetUpdateMask

func (x *UpdateNotificationSubscriptionRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateNotificationSubscriptionRequest) ProtoMessage

func (*UpdateNotificationSubscriptionRequest) ProtoMessage()

func (*UpdateNotificationSubscriptionRequest) ProtoReflect

func (x *UpdateNotificationSubscriptionRequest) ProtoReflect() protoreflect.Message

func (*UpdateNotificationSubscriptionRequest) Reset

func (x *UpdateNotificationSubscriptionRequest) Reset()

func (*UpdateNotificationSubscriptionRequest) String

func (x *UpdateNotificationSubscriptionRequest) String() string