google-cloud-commerce-consumer-procurement-v1 0.a → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (34) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +149 -0
  4. data/README.md +144 -8
  5. data/lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/client.rb +680 -0
  6. data/lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/credentials.rb +51 -0
  7. data/lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/operations.rb +783 -0
  8. data/lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/paths.rb +90 -0
  9. data/lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/rest/client.rb +630 -0
  10. data/lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/rest/operations.rb +874 -0
  11. data/lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/rest/service_stub.rb +230 -0
  12. data/lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/rest.rb +65 -0
  13. data/lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service.rb +68 -0
  14. data/lib/google/cloud/commerce/consumer/procurement/v1/order_pb.rb +60 -0
  15. data/lib/google/cloud/commerce/consumer/procurement/v1/procurement_service_pb.rb +58 -0
  16. data/lib/google/cloud/commerce/consumer/procurement/v1/procurement_service_services_pb.rb +74 -0
  17. data/lib/google/cloud/commerce/consumer/procurement/v1/rest.rb +41 -0
  18. data/lib/google/cloud/commerce/consumer/procurement/v1/version.rb +7 -2
  19. data/lib/google/cloud/commerce/consumer/procurement/v1.rb +49 -0
  20. data/lib/google-cloud-commerce-consumer-procurement-v1.rb +21 -0
  21. data/proto_docs/README.md +4 -0
  22. data/proto_docs/google/api/client.rb +381 -0
  23. data/proto_docs/google/api/field_behavior.rb +85 -0
  24. data/proto_docs/google/api/launch_stage.rb +71 -0
  25. data/proto_docs/google/api/resource.rb +222 -0
  26. data/proto_docs/google/cloud/commerce/consumer/procurement/v1/order.rb +262 -0
  27. data/proto_docs/google/cloud/commerce/consumer/procurement/v1/procurement_service.rb +122 -0
  28. data/proto_docs/google/longrunning/operations.rb +164 -0
  29. data/proto_docs/google/protobuf/any.rb +144 -0
  30. data/proto_docs/google/protobuf/duration.rb +98 -0
  31. data/proto_docs/google/protobuf/empty.rb +34 -0
  32. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  33. data/proto_docs/google/rpc/status.rb +48 -0
  34. metadata +188 -13
@@ -0,0 +1,222 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 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
+
20
+ module Google
21
+ module Api
22
+ # A simple descriptor of a resource type.
23
+ #
24
+ # ResourceDescriptor annotates a resource message (either by means of a
25
+ # protobuf annotation or use in the service config), and associates the
26
+ # resource's schema, the resource type, and the pattern of the resource name.
27
+ #
28
+ # Example:
29
+ #
30
+ # message Topic {
31
+ # // Indicates this message defines a resource schema.
32
+ # // Declares the resource type in the format of {service}/{kind}.
33
+ # // For Kubernetes resources, the format is {api group}/{kind}.
34
+ # option (google.api.resource) = {
35
+ # type: "pubsub.googleapis.com/Topic"
36
+ # pattern: "projects/{project}/topics/{topic}"
37
+ # };
38
+ # }
39
+ #
40
+ # The ResourceDescriptor Yaml config will look like:
41
+ #
42
+ # resources:
43
+ # - type: "pubsub.googleapis.com/Topic"
44
+ # pattern: "projects/{project}/topics/{topic}"
45
+ #
46
+ # Sometimes, resources have multiple patterns, typically because they can
47
+ # live under multiple parents.
48
+ #
49
+ # Example:
50
+ #
51
+ # message LogEntry {
52
+ # option (google.api.resource) = {
53
+ # type: "logging.googleapis.com/LogEntry"
54
+ # pattern: "projects/{project}/logs/{log}"
55
+ # pattern: "folders/{folder}/logs/{log}"
56
+ # pattern: "organizations/{organization}/logs/{log}"
57
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
58
+ # };
59
+ # }
60
+ #
61
+ # The ResourceDescriptor Yaml config will look like:
62
+ #
63
+ # resources:
64
+ # - type: 'logging.googleapis.com/LogEntry'
65
+ # pattern: "projects/{project}/logs/{log}"
66
+ # pattern: "folders/{folder}/logs/{log}"
67
+ # pattern: "organizations/{organization}/logs/{log}"
68
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
69
+ # @!attribute [rw] type
70
+ # @return [::String]
71
+ # The resource type. It must be in the format of
72
+ # \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
73
+ # singular and must not include version numbers.
74
+ #
75
+ # Example: `storage.googleapis.com/Bucket`
76
+ #
77
+ # The value of the resource_type_kind must follow the regular expression
78
+ # /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
79
+ # should use PascalCase (UpperCamelCase). The maximum number of
80
+ # characters allowed for the `resource_type_kind` is 100.
81
+ # @!attribute [rw] pattern
82
+ # @return [::Array<::String>]
83
+ # Optional. The relative resource name pattern associated with this resource
84
+ # type. The DNS prefix of the full resource name shouldn't be specified here.
85
+ #
86
+ # The path pattern must follow the syntax, which aligns with HTTP binding
87
+ # syntax:
88
+ #
89
+ # Template = Segment { "/" Segment } ;
90
+ # Segment = LITERAL | Variable ;
91
+ # Variable = "{" LITERAL "}" ;
92
+ #
93
+ # Examples:
94
+ #
95
+ # - "projects/\\{project}/topics/\\{topic}"
96
+ # - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
97
+ #
98
+ # The components in braces correspond to the IDs for each resource in the
99
+ # hierarchy. It is expected that, if multiple patterns are provided,
100
+ # the same component name (e.g. "project") refers to IDs of the same
101
+ # type of resource.
102
+ # @!attribute [rw] name_field
103
+ # @return [::String]
104
+ # Optional. The field on the resource that designates the resource name
105
+ # field. If omitted, this is assumed to be "name".
106
+ # @!attribute [rw] history
107
+ # @return [::Google::Api::ResourceDescriptor::History]
108
+ # Optional. The historical or future-looking state of the resource pattern.
109
+ #
110
+ # Example:
111
+ #
112
+ # // The InspectTemplate message originally only supported resource
113
+ # // names with organization, and project was added later.
114
+ # message InspectTemplate {
115
+ # option (google.api.resource) = {
116
+ # type: "dlp.googleapis.com/InspectTemplate"
117
+ # pattern:
118
+ # "organizations/{organization}/inspectTemplates/{inspect_template}"
119
+ # pattern: "projects/{project}/inspectTemplates/{inspect_template}"
120
+ # history: ORIGINALLY_SINGLE_PATTERN
121
+ # };
122
+ # }
123
+ # @!attribute [rw] plural
124
+ # @return [::String]
125
+ # The plural name used in the resource name and permission names, such as
126
+ # 'projects' for the resource name of 'projects/\\{project}' and the permission
127
+ # name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
128
+ # concept of the `plural` field in k8s CRD spec
129
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
130
+ #
131
+ # Note: The plural form is required even for singleton resources. See
132
+ # https://aip.dev/156
133
+ # @!attribute [rw] singular
134
+ # @return [::String]
135
+ # The same concept of the `singular` field in k8s CRD spec
136
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
137
+ # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
138
+ # @!attribute [rw] style
139
+ # @return [::Array<::Google::Api::ResourceDescriptor::Style>]
140
+ # Style flag(s) for this resource.
141
+ # These indicate that a resource is expected to conform to a given
142
+ # style. See the specific style flags for additional information.
143
+ class ResourceDescriptor
144
+ include ::Google::Protobuf::MessageExts
145
+ extend ::Google::Protobuf::MessageExts::ClassMethods
146
+
147
+ # A description of the historical or future-looking state of the
148
+ # resource pattern.
149
+ module History
150
+ # The "unset" value.
151
+ HISTORY_UNSPECIFIED = 0
152
+
153
+ # The resource originally had one pattern and launched as such, and
154
+ # additional patterns were added later.
155
+ ORIGINALLY_SINGLE_PATTERN = 1
156
+
157
+ # The resource has one pattern, but the API owner expects to add more
158
+ # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
159
+ # that from being necessary once there are multiple patterns.)
160
+ FUTURE_MULTI_PATTERN = 2
161
+ end
162
+
163
+ # A flag representing a specific style that a resource claims to conform to.
164
+ module Style
165
+ # The unspecified value. Do not use.
166
+ STYLE_UNSPECIFIED = 0
167
+
168
+ # This resource is intended to be "declarative-friendly".
169
+ #
170
+ # Declarative-friendly resources must be more strictly consistent, and
171
+ # setting this to true communicates to tools that this resource should
172
+ # adhere to declarative-friendly expectations.
173
+ #
174
+ # Note: This is used by the API linter (linter.aip.dev) to enable
175
+ # additional checks.
176
+ DECLARATIVE_FRIENDLY = 1
177
+ end
178
+ end
179
+
180
+ # Defines a proto annotation that describes a string field that refers to
181
+ # an API resource.
182
+ # @!attribute [rw] type
183
+ # @return [::String]
184
+ # The resource type that the annotated field references.
185
+ #
186
+ # Example:
187
+ #
188
+ # message Subscription {
189
+ # string topic = 2 [(google.api.resource_reference) = {
190
+ # type: "pubsub.googleapis.com/Topic"
191
+ # }];
192
+ # }
193
+ #
194
+ # Occasionally, a field may reference an arbitrary resource. In this case,
195
+ # APIs use the special value * in their resource reference.
196
+ #
197
+ # Example:
198
+ #
199
+ # message GetIamPolicyRequest {
200
+ # string resource = 2 [(google.api.resource_reference) = {
201
+ # type: "*"
202
+ # }];
203
+ # }
204
+ # @!attribute [rw] child_type
205
+ # @return [::String]
206
+ # The resource type of a child collection that the annotated field
207
+ # references. This is useful for annotating the `parent` field that
208
+ # doesn't have a fixed resource type.
209
+ #
210
+ # Example:
211
+ #
212
+ # message ListLogEntriesRequest {
213
+ # string parent = 1 [(google.api.resource_reference) = {
214
+ # child_type: "logging.googleapis.com/LogEntry"
215
+ # };
216
+ # }
217
+ class ResourceReference
218
+ include ::Google::Protobuf::MessageExts
219
+ extend ::Google::Protobuf::MessageExts::ClassMethods
220
+ end
221
+ end
222
+ end
@@ -0,0 +1,262 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 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
+
20
+ module Google
21
+ module Cloud
22
+ module Commerce
23
+ module Consumer
24
+ module Procurement
25
+ module V1
26
+ # Represents a purchase made by a customer on Cloud Marketplace.
27
+ # Creating an order makes sure that both the Google backend systems
28
+ # as well as external service provider's systems (if needed) allow use of
29
+ # purchased products and ensures the appropriate billing events occur.
30
+ #
31
+ # An Order can be made against one Product with multiple add-ons (optional) or
32
+ # one Quote which might reference multiple products.
33
+ #
34
+ # Customers typically choose a price plan for each Product purchased when
35
+ # they create an order and can change their plan later, if the product allows.
36
+ # @!attribute [r] name
37
+ # @return [::String]
38
+ # Output only. The resource name of the order.
39
+ # Has the form
40
+ # `billingAccounts/{billing_account}/orders/{order}`.
41
+ # @!attribute [rw] display_name
42
+ # @return [::String]
43
+ # Required. The user-specified name of the order.
44
+ # @!attribute [r] line_items
45
+ # @return [::Array<::Google::Cloud::Commerce::Consumer::Procurement::V1::LineItem>]
46
+ # Output only. The items being purchased.
47
+ # @!attribute [r] cancelled_line_items
48
+ # @return [::Array<::Google::Cloud::Commerce::Consumer::Procurement::V1::LineItem>]
49
+ # Output only. Line items that were cancelled.
50
+ # @!attribute [r] create_time
51
+ # @return [::Google::Protobuf::Timestamp]
52
+ # Output only. The creation timestamp.
53
+ # @!attribute [r] update_time
54
+ # @return [::Google::Protobuf::Timestamp]
55
+ # Output only. The last update timestamp.
56
+ # @!attribute [rw] etag
57
+ # @return [::String]
58
+ # The weak etag of the order.
59
+ class Order
60
+ include ::Google::Protobuf::MessageExts
61
+ extend ::Google::Protobuf::MessageExts::ClassMethods
62
+ end
63
+
64
+ # A single item within an order.
65
+ # @!attribute [r] line_item_id
66
+ # @return [::String]
67
+ # Output only. Line item ID.
68
+ # @!attribute [r] line_item_info
69
+ # @return [::Google::Cloud::Commerce::Consumer::Procurement::V1::LineItemInfo]
70
+ # Output only. Current state and information of this item. It tells what,
71
+ # e.g. which offer, is currently effective.
72
+ # @!attribute [r] pending_change
73
+ # @return [::Google::Cloud::Commerce::Consumer::Procurement::V1::LineItemChange]
74
+ # Output only. A change made on the item which is pending and not yet
75
+ # effective. Absence of this field indicates the line item is not undergoing
76
+ # a change.
77
+ # @!attribute [r] change_history
78
+ # @return [::Array<::Google::Cloud::Commerce::Consumer::Procurement::V1::LineItemChange>]
79
+ # Output only. Changes made on the item that are not pending anymore which
80
+ # might be because they already took effect, were reverted by the customer,
81
+ # or were rejected by the partner. No more operations are allowed on these
82
+ # changes.
83
+ class LineItem
84
+ include ::Google::Protobuf::MessageExts
85
+ extend ::Google::Protobuf::MessageExts::ClassMethods
86
+ end
87
+
88
+ # A change made on a line item.
89
+ # @!attribute [r] change_id
90
+ # @return [::String]
91
+ # Output only. Change ID.
92
+ # All changes made within one order update operation have the same change_id.
93
+ # @!attribute [rw] change_type
94
+ # @return [::Google::Cloud::Commerce::Consumer::Procurement::V1::LineItemChangeType]
95
+ # Required. Type of the change to make.
96
+ # @!attribute [r] old_line_item_info
97
+ # @return [::Google::Cloud::Commerce::Consumer::Procurement::V1::LineItemInfo]
98
+ # Output only. Line item info before the change.
99
+ # @!attribute [rw] new_line_item_info
100
+ # @return [::Google::Cloud::Commerce::Consumer::Procurement::V1::LineItemInfo]
101
+ # Line item info after the change.
102
+ # @!attribute [r] change_state
103
+ # @return [::Google::Cloud::Commerce::Consumer::Procurement::V1::LineItemChangeState]
104
+ # Output only. State of the change.
105
+ # @!attribute [r] state_reason
106
+ # @return [::String]
107
+ # Output only. Provider-supplied message explaining the LineItemChange's
108
+ # state. Mainly used to communicate progress and ETA for provisioning in the
109
+ # case of `PENDING_APPROVAL`, and to explain why the change request was
110
+ # denied or canceled in the case of `REJECTED` and `CANCELED` states.
111
+ # @!attribute [r] change_state_reason_type
112
+ # @return [::Google::Cloud::Commerce::Consumer::Procurement::V1::LineItemChangeStateReasonType]
113
+ # Output only. Predefined enum types for why this line item change is in
114
+ # current state. For example, a line item change's state could be
115
+ # `LINE_ITEM_CHANGE_STATE_COMPLETED` because of end-of-term expiration,
116
+ # immediate cancellation initiated by the user, or system-initiated
117
+ # cancellation.
118
+ # @!attribute [r] change_effective_time
119
+ # @return [::Google::Protobuf::Timestamp]
120
+ # Output only. A time at which the change became or will become (in case of
121
+ # pending change) effective.
122
+ # @!attribute [r] create_time
123
+ # @return [::Google::Protobuf::Timestamp]
124
+ # Output only. The time when change was initiated.
125
+ # @!attribute [r] update_time
126
+ # @return [::Google::Protobuf::Timestamp]
127
+ # Output only. The time when change was updated, e.g. approved/rejected by
128
+ # partners or cancelled by the user.
129
+ class LineItemChange
130
+ include ::Google::Protobuf::MessageExts
131
+ extend ::Google::Protobuf::MessageExts::ClassMethods
132
+ end
133
+
134
+ # Line item information.
135
+ # @!attribute [rw] offer
136
+ # @return [::String]
137
+ # Optional. The name of the offer can have either of these formats:
138
+ # 'billingAccounts/\\{billing_account}/offers/\\{offer}',
139
+ # or 'services/\\{service}/standardOffers/\\{offer}'.
140
+ # @!attribute [rw] parameters
141
+ # @return [::Array<::Google::Cloud::Commerce::Consumer::Procurement::V1::Parameter>]
142
+ # Optional. User-provided parameters.
143
+ # @!attribute [r] subscription
144
+ # @return [::Google::Cloud::Commerce::Consumer::Procurement::V1::Subscription]
145
+ # Output only. Information about the subscription created, if applicable.
146
+ class LineItemInfo
147
+ include ::Google::Protobuf::MessageExts
148
+ extend ::Google::Protobuf::MessageExts::ClassMethods
149
+ end
150
+
151
+ # User-provided Parameters.
152
+ # @!attribute [rw] name
153
+ # @return [::String]
154
+ # Name of the parameter.
155
+ # @!attribute [rw] value
156
+ # @return [::Google::Cloud::Commerce::Consumer::Procurement::V1::Parameter::Value]
157
+ # Value of parameter.
158
+ class Parameter
159
+ include ::Google::Protobuf::MessageExts
160
+ extend ::Google::Protobuf::MessageExts::ClassMethods
161
+
162
+ # @!attribute [rw] int64_value
163
+ # @return [::Integer]
164
+ # Represents an int64 value.
165
+ # @!attribute [rw] string_value
166
+ # @return [::String]
167
+ # Represents a string value.
168
+ # @!attribute [rw] double_value
169
+ # @return [::Float]
170
+ # Represents a double value.
171
+ class Value
172
+ include ::Google::Protobuf::MessageExts
173
+ extend ::Google::Protobuf::MessageExts::ClassMethods
174
+ end
175
+ end
176
+
177
+ # Subscription information.
178
+ # @!attribute [rw] start_time
179
+ # @return [::Google::Protobuf::Timestamp]
180
+ # The timestamp when the subscription begins, if applicable.
181
+ # @!attribute [rw] end_time
182
+ # @return [::Google::Protobuf::Timestamp]
183
+ # The timestamp when the subscription ends, if applicable.
184
+ # @!attribute [rw] auto_renewal_enabled
185
+ # @return [::Boolean]
186
+ # Whether auto renewal is enabled by user choice on current subscription.
187
+ # This field indicates order/subscription status after pending plan change is
188
+ # cancelled or rejected.
189
+ class Subscription
190
+ include ::Google::Protobuf::MessageExts
191
+ extend ::Google::Protobuf::MessageExts::ClassMethods
192
+ end
193
+
194
+ # Type of a line item change.
195
+ module LineItemChangeType
196
+ # Sentinel value. Do not use.
197
+ LINE_ITEM_CHANGE_TYPE_UNSPECIFIED = 0
198
+
199
+ # The change is to create a new line item.
200
+ LINE_ITEM_CHANGE_TYPE_CREATE = 1
201
+
202
+ # The change is to update an existing line item.
203
+ LINE_ITEM_CHANGE_TYPE_UPDATE = 2
204
+
205
+ # The change is to cancel an existing line item.
206
+ LINE_ITEM_CHANGE_TYPE_CANCEL = 3
207
+
208
+ # The change is to revert a cancellation.
209
+ LINE_ITEM_CHANGE_TYPE_REVERT_CANCELLATION = 4
210
+ end
211
+
212
+ # State of a change.
213
+ module LineItemChangeState
214
+ # Sentinel value. Do not use.
215
+ LINE_ITEM_CHANGE_STATE_UNSPECIFIED = 0
216
+
217
+ # Change is in this state when a change is initiated and waiting for
218
+ # partner approval.
219
+ LINE_ITEM_CHANGE_STATE_PENDING_APPROVAL = 1
220
+
221
+ # Change is in this state after it's approved by the partner or auto-approved
222
+ # but before it takes effect. The change can be overwritten
223
+ # or cancelled depending on the new line item info property (pending Private
224
+ # Offer change cannot be cancelled and can only be overwritten by another
225
+ # Private Offer).
226
+ LINE_ITEM_CHANGE_STATE_APPROVED = 2
227
+
228
+ # Change is in this state after it's been activated.
229
+ LINE_ITEM_CHANGE_STATE_COMPLETED = 3
230
+
231
+ # Change is in this state if it was rejected by the partner.
232
+ LINE_ITEM_CHANGE_STATE_REJECTED = 4
233
+
234
+ # Change is in this state if it was abandoned by the user.
235
+ LINE_ITEM_CHANGE_STATE_ABANDONED = 5
236
+
237
+ # Change is in this state if it's currently being provisioned downstream. The
238
+ # change can't be overwritten or cancelled when it's in this state.
239
+ LINE_ITEM_CHANGE_STATE_ACTIVATING = 6
240
+ end
241
+
242
+ # Predefined types for line item change state reason.
243
+ module LineItemChangeStateReasonType
244
+ # Default value, indicating there's no predefined type for change state
245
+ # reason.
246
+ LINE_ITEM_CHANGE_STATE_REASON_TYPE_UNSPECIFIED = 0
247
+
248
+ # Change is in current state due to term expiration.
249
+ LINE_ITEM_CHANGE_STATE_REASON_TYPE_EXPIRED = 1
250
+
251
+ # Change is in current state due to user-initiated cancellation.
252
+ LINE_ITEM_CHANGE_STATE_REASON_TYPE_USER_CANCELLED = 2
253
+
254
+ # Change is in current state due to system-initiated cancellation.
255
+ LINE_ITEM_CHANGE_STATE_REASON_TYPE_SYSTEM_CANCELLED = 3
256
+ end
257
+ end
258
+ end
259
+ end
260
+ end
261
+ end
262
+ end
@@ -0,0 +1,122 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 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
+
20
+ module Google
21
+ module Cloud
22
+ module Commerce
23
+ module Consumer
24
+ module Procurement
25
+ module V1
26
+ # Request message for
27
+ # {::Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Client#place_order ConsumerProcurementService.PlaceOrder}.
28
+ # @!attribute [rw] parent
29
+ # @return [::String]
30
+ # Required. The resource name of the parent resource.
31
+ # This field has the form `billingAccounts/{billing-account-id}`.
32
+ # @!attribute [rw] display_name
33
+ # @return [::String]
34
+ # Required. The user-specified name of the order being placed.
35
+ # @!attribute [rw] line_item_info
36
+ # @return [::Array<::Google::Cloud::Commerce::Consumer::Procurement::V1::LineItemInfo>]
37
+ # Optional. Places order for offer. Required when an offer-based order is
38
+ # being placed.
39
+ # @!attribute [rw] request_id
40
+ # @return [::String]
41
+ # Optional. A unique identifier for this request.
42
+ # The server will ignore subsequent requests that provide a duplicate request
43
+ # ID for at least 120 minutes after the first request.
44
+ #
45
+ # The request ID must be a valid
46
+ # [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format).
47
+ class PlaceOrderRequest
48
+ include ::Google::Protobuf::MessageExts
49
+ extend ::Google::Protobuf::MessageExts::ClassMethods
50
+ end
51
+
52
+ # Message stored in the metadata field of the Operation returned by
53
+ # {::Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Client#place_order ConsumerProcurementService.PlaceOrder}.
54
+ class PlaceOrderMetadata
55
+ include ::Google::Protobuf::MessageExts
56
+ extend ::Google::Protobuf::MessageExts::ClassMethods
57
+ end
58
+
59
+ # Request message for
60
+ # {::Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Client#get_order ConsumerProcurementService.GetOrder}
61
+ # @!attribute [rw] name
62
+ # @return [::String]
63
+ # Required. The name of the order to retrieve.
64
+ class GetOrderRequest
65
+ include ::Google::Protobuf::MessageExts
66
+ extend ::Google::Protobuf::MessageExts::ClassMethods
67
+ end
68
+
69
+ # Request message for
70
+ # {::Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Client#list_orders ConsumerProcurementService.ListOrders}.
71
+ # @!attribute [rw] parent
72
+ # @return [::String]
73
+ # Required. The parent resource to query for orders.
74
+ # This field has the form `billingAccounts/{billing-account-id}`.
75
+ # @!attribute [rw] page_size
76
+ # @return [::Integer]
77
+ # The maximum number of entries requested.
78
+ # The default page size is 25 and the maximum page size is 200.
79
+ # @!attribute [rw] page_token
80
+ # @return [::String]
81
+ # The token for fetching the next page.
82
+ # @!attribute [rw] filter
83
+ # @return [::String]
84
+ # Filter that you can use to limit the list request.
85
+ #
86
+ # A query string that can match a selected set of attributes
87
+ # with string values. For example, `display_name=abc`.
88
+ # Supported query attributes are
89
+ #
90
+ # * `display_name`
91
+ #
92
+ # If the query contains special characters other than letters,
93
+ # underscore, or digits, the phrase must be quoted with double quotes. For
94
+ # example, `display_name="foo:bar"`, where the display name needs to be
95
+ # quoted because it contains special character colon.
96
+ #
97
+ # Queries can be combined with `OR`, and `NOT` to form more complex queries.
98
+ # You can also group them to force a desired evaluation order.
99
+ # For example, `display_name=abc OR display_name=def`.
100
+ class ListOrdersRequest
101
+ include ::Google::Protobuf::MessageExts
102
+ extend ::Google::Protobuf::MessageExts::ClassMethods
103
+ end
104
+
105
+ # Response message for
106
+ # {::Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Client#list_orders ConsumerProcurementService.ListOrders}.
107
+ # @!attribute [rw] orders
108
+ # @return [::Array<::Google::Cloud::Commerce::Consumer::Procurement::V1::Order>]
109
+ # The list of orders in this response.
110
+ # @!attribute [rw] next_page_token
111
+ # @return [::String]
112
+ # The token for fetching the next page.
113
+ class ListOrdersResponse
114
+ include ::Google::Protobuf::MessageExts
115
+ extend ::Google::Protobuf::MessageExts::ClassMethods
116
+ end
117
+ end
118
+ end
119
+ end
120
+ end
121
+ end
122
+ end