google-shopping-merchant-notifications-v1 0.a → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (27) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +122 -0
  4. data/README.md +154 -8
  5. data/lib/google/shopping/merchant/notifications/v1/notifications_api_service/client.rb +971 -0
  6. data/lib/google/shopping/merchant/notifications/v1/notifications_api_service/credentials.rb +49 -0
  7. data/lib/google/shopping/merchant/notifications/v1/notifications_api_service/paths.rb +83 -0
  8. data/lib/google/shopping/merchant/notifications/v1/notifications_api_service/rest/client.rb +903 -0
  9. data/lib/google/shopping/merchant/notifications/v1/notifications_api_service/rest/service_stub.rb +451 -0
  10. data/lib/google/shopping/merchant/notifications/v1/notifications_api_service/rest.rb +54 -0
  11. data/lib/google/shopping/merchant/notifications/v1/notifications_api_service.rb +57 -0
  12. data/lib/google/shopping/merchant/notifications/v1/notificationsapi_pb.rb +61 -0
  13. data/lib/google/shopping/merchant/notifications/v1/notificationsapi_services_pb.rb +81 -0
  14. data/lib/google/shopping/merchant/notifications/v1/rest.rb +39 -0
  15. data/lib/google/shopping/merchant/notifications/v1/version.rb +7 -2
  16. data/lib/google/shopping/merchant/notifications/v1.rb +47 -0
  17. data/lib/google-shopping-merchant-notifications-v1.rb +21 -0
  18. data/proto_docs/README.md +4 -0
  19. data/proto_docs/google/api/client.rb +473 -0
  20. data/proto_docs/google/api/field_behavior.rb +85 -0
  21. data/proto_docs/google/api/launch_stage.rb +71 -0
  22. data/proto_docs/google/api/resource.rb +227 -0
  23. data/proto_docs/google/protobuf/duration.rb +98 -0
  24. data/proto_docs/google/protobuf/empty.rb +34 -0
  25. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  26. data/proto_docs/google/shopping/merchant/notifications/v1/notificationsapi.rb +184 -0
  27. metadata +71 -9
@@ -0,0 +1,81 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # Source: google/shopping/merchant/notifications/v1/notificationsapi.proto for package 'Google.Shopping.Merchant.Notifications.V1'
3
+ # Original file comments:
4
+ # Copyright 2025 Google LLC
5
+ #
6
+ # Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ # See the License for the specific language governing permissions and
16
+ # limitations under the License.
17
+ #
18
+
19
+ require 'grpc'
20
+ require 'google/shopping/merchant/notifications/v1/notificationsapi_pb'
21
+
22
+ module Google
23
+ module Shopping
24
+ module Merchant
25
+ module Notifications
26
+ module V1
27
+ module NotificationsApiService
28
+ # Service to manage notification subscriptions for merchants
29
+ class Service
30
+
31
+ include ::GRPC::GenericService
32
+
33
+ self.marshal_class_method = :encode
34
+ self.unmarshal_class_method = :decode
35
+ self.service_name = 'google.shopping.merchant.notifications.v1.NotificationsApiService'
36
+
37
+ # Gets notification subscriptions for an account.
38
+ rpc :GetNotificationSubscription, ::Google::Shopping::Merchant::Notifications::V1::GetNotificationSubscriptionRequest, ::Google::Shopping::Merchant::Notifications::V1::NotificationSubscription
39
+ # Creates a notification subscription for a business.
40
+ # For standalone or subaccounts accounts, the business can create a
41
+ # subscription for self. For MCAs, the business can create a
42
+ # subscription for all managed accounts or for a specific subaccount.
43
+ #
44
+ # We will allow the following types of notification subscriptions to exist
45
+ # together (per business as a subscriber per event type):
46
+ #
47
+ # 1. Subscription for all managed accounts + subscription for self.
48
+ #
49
+ # 2. Multiple "partial" subscriptions for managed accounts + subscription
50
+ # for self.
51
+ #
52
+ # we will not allow (per business as a subscriber per event type):
53
+ #
54
+ # 1. Multiple self subscriptions.
55
+ #
56
+ # 2. Multiple "all managed accounts" subscriptions.
57
+ #
58
+ # 3. "All managed accounts" subscription and partial subscriptions at the
59
+ # same time.
60
+ #
61
+ # 4. Multiple partial subscriptions for the same target account.
62
+ rpc :CreateNotificationSubscription, ::Google::Shopping::Merchant::Notifications::V1::CreateNotificationSubscriptionRequest, ::Google::Shopping::Merchant::Notifications::V1::NotificationSubscription
63
+ # Updates an existing notification subscription for a merchant.
64
+ rpc :UpdateNotificationSubscription, ::Google::Shopping::Merchant::Notifications::V1::UpdateNotificationSubscriptionRequest, ::Google::Shopping::Merchant::Notifications::V1::NotificationSubscription
65
+ # Deletes a notification subscription for a merchant.
66
+ rpc :DeleteNotificationSubscription, ::Google::Shopping::Merchant::Notifications::V1::DeleteNotificationSubscriptionRequest, ::Google::Protobuf::Empty
67
+ # Gets all the notification subscriptions for a merchant.
68
+ rpc :ListNotificationSubscriptions, ::Google::Shopping::Merchant::Notifications::V1::ListNotificationSubscriptionsRequest, ::Google::Shopping::Merchant::Notifications::V1::ListNotificationSubscriptionsResponse
69
+ # Retrieves notification subscription health metrics for a merchant.
70
+ # We recommend calling this periodically (hourly or daily) to monitor health
71
+ # of your callback endpoint.
72
+ rpc :GetNotificationSubscriptionHealthMetrics, ::Google::Shopping::Merchant::Notifications::V1::GetNotificationSubscriptionHealthMetricsRequest, ::Google::Shopping::Merchant::Notifications::V1::NotificationSubscriptionHealthMetrics
73
+ end
74
+
75
+ Stub = Service.rpc_stub_class
76
+ end
77
+ end
78
+ end
79
+ end
80
+ end
81
+ end
@@ -0,0 +1,39 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ require "google/shopping/merchant/notifications/v1/notifications_api_service/rest"
20
+ require "google/shopping/merchant/notifications/v1/version"
21
+
22
+ module Google
23
+ module Shopping
24
+ module Merchant
25
+ module Notifications
26
+ ##
27
+ # To load just the REST part of this package, including all its services, and instantiate a REST client:
28
+ #
29
+ # @example
30
+ #
31
+ # require "google/shopping/merchant/notifications/v1/rest"
32
+ # client = ::Google::Shopping::Merchant::Notifications::V1::NotificationsApiService::Rest::Client.new
33
+ #
34
+ module V1
35
+ end
36
+ end
37
+ end
38
+ end
39
+ end
@@ -1,10 +1,12 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # Copyright 2025 Google LLC
2
4
  #
3
5
  # Licensed under the Apache License, Version 2.0 (the "License");
4
6
  # you may not use this file except in compliance with the License.
5
7
  # You may obtain a copy of the License at
6
8
  #
7
- # http://www.apache.org/licenses/LICENSE-2.0
9
+ # https://www.apache.org/licenses/LICENSE-2.0
8
10
  #
9
11
  # Unless required by applicable law or agreed to in writing, software
10
12
  # distributed under the License is distributed on an "AS IS" BASIS,
@@ -12,12 +14,15 @@
12
14
  # See the License for the specific language governing permissions and
13
15
  # limitations under the License.
14
16
 
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
15
20
  module Google
16
21
  module Shopping
17
22
  module Merchant
18
23
  module Notifications
19
24
  module V1
20
- VERSION = "0.a"
25
+ VERSION = "0.1.0"
21
26
  end
22
27
  end
23
28
  end
@@ -0,0 +1,47 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ require "google/shopping/merchant/notifications/v1/notifications_api_service"
20
+ require "google/shopping/merchant/notifications/v1/version"
21
+
22
+ module Google
23
+ module Shopping
24
+ module Merchant
25
+ module Notifications
26
+ ##
27
+ # API client module.
28
+ #
29
+ # @example Load this package, including all its services, and instantiate a gRPC client
30
+ #
31
+ # require "google/shopping/merchant/notifications/v1"
32
+ # client = ::Google::Shopping::Merchant::Notifications::V1::NotificationsApiService::Client.new
33
+ #
34
+ # @example Load this package, including all its services, and instantiate a REST client
35
+ #
36
+ # require "google/shopping/merchant/notifications/v1"
37
+ # client = ::Google::Shopping::Merchant::Notifications::V1::NotificationsApiService::Rest::Client.new
38
+ #
39
+ module V1
40
+ end
41
+ end
42
+ end
43
+ end
44
+ end
45
+
46
+ helper_path = ::File.join __dir__, "v1", "_helpers.rb"
47
+ require "google/shopping/merchant/notifications/v1/_helpers" if ::File.file? helper_path
@@ -0,0 +1,21 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ # This gem does not autoload during Bundler.require. To load this gem,
20
+ # issue explicit require statements for the packages desired, e.g.:
21
+ # require "google/shopping/merchant/notifications/v1"
@@ -0,0 +1,4 @@
1
+ # Merchant V1 Protocol Buffer Documentation
2
+
3
+ These files are for the YARD documentation of the generated protobuf files.
4
+ They are not intended to be required or loaded at runtime.