google-cloud-support-v2 0.a → 0.1.0

data/proto_docs/google/cloud/support/v2/case_service.rb

@@ -0,0 +1,240 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Support
+      module V2
+        # The request message for the GetCase endpoint.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The fully qualified name of a case to be retrieved.
+        class GetCaseRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request message for the CreateCase endpoint.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The name of the Google Cloud Resource under which the case should
+        #     be created.
+        # @!attribute [rw] case
+        #   @return [::Google::Cloud::Support::V2::Case]
+        #     Required. The case to be created.
+        class CreateCaseRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request message for the ListCases endpoint.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The fully qualified name of parent resource to list cases under.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     An expression written in filter language. If non-empty, the query returns
+        #     the cases that match the filter. Else, the query doesn't filter the cases.
+        #
+        #     Filter expressions use the following fields with the operators equals (`=`)
+        #     and `AND`:
+        #
+        #     - `state`: The accepted values are `OPEN` or `CLOSED`.
+        #     - `priority`: The accepted values are `P0`, `P1`, `P2`, `P3`, or `P4`. You
+        #     can specify multiple values for priority using the `OR` operator. For
+        #     example, `priority=P1 OR priority=P2`.
+        #     - `creator.email`: The email address of the case creator.
+        #
+        #     Examples:
+        #
+        #     - `state=CLOSED`
+        #     - `state=OPEN AND creator.email="tester@example.com"`
+        #     - `state=OPEN AND (priority=P0 OR priority=P1)`
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     The maximum number of cases fetched with each request. Defaults to 10.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A token identifying the page of results to return. If unspecified, the
+        #     first page is retrieved.
+        class ListCasesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response message for the ListCases endpoint.
+        # @!attribute [rw] cases
+        #   @return [::Array<::Google::Cloud::Support::V2::Case>]
+        #     The list of cases associated with the Google Cloud Resource, after any
+        #     filters have been applied.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token to retrieve the next page of results. This should be set in the
+        #     `page_token` field of the subsequent `ListCasesRequest` message that is
+        #     issued. If unspecified, there are no more results to retrieve.
+        class ListCasesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request message for the SearchCases endpoint.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     The fully qualified name of parent resource to search cases under.
+        # @!attribute [rw] query
+        #   @return [::String]
+        #     An expression written in filter language.
+        #
+        #     A query uses the following fields with the operators equals (`=`) and
+        #     `AND`:
+        #
+        #     - `organization`: An organization name in the form
+        #     `organizations/<organization_id>`.
+        #     - `project`: A project name in the form `projects/<project_id>`.
+        #     - `state`: The accepted values are `OPEN` or `CLOSED`.
+        #     - `priority`: The accepted values are `P0`, `P1`, `P2`, `P3`, or `P4`. You
+        #     can specify multiple values for priority using the `OR` operator. For
+        #     example, `priority=P1 OR priority=P2`.
+        #     - `creator.email`: The email address of the case creator.
+        #     - `billingAccount`: A billing account in the form
+        #     `billingAccounts/<billing_account_id>`
+        #
+        #     You must specify either `organization` or `project`.
+        #
+        #     To search across `displayName`, `description`, and comments, use a global
+        #     restriction with no keyword or operator. For example, `"my search"`.
+        #
+        #     To search only cases updated after a certain date, use `update_time`
+        #     restricted with that particular date, time, and timezone in ISO datetime
+        #     format. For example, `update_time>"2020-01-01T00:00:00-05:00"`.
+        #     `update_time` only supports the greater than operator (`>`).
+        #
+        #     Examples:
+        #
+        #     - `organization="organizations/123456789"`
+        #     - `project="projects/my-project-id"`
+        #     - `project="projects/123456789"`
+        #     - `billing_account="billingAccounts/123456-A0B0C0-CUZ789"`
+        #     - `organization="organizations/123456789" AND state=CLOSED`
+        #     - `project="projects/my-project-id" AND creator.email="tester@example.com"`
+        #     - `project="projects/my-project-id" AND (priority=P0 OR priority=P1)`
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     The maximum number of cases fetched with each request. The default page
+        #     size is 10.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A token identifying the page of results to return. If unspecified, the
+        #     first page is retrieved.
+        class SearchCasesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response message for the SearchCases endpoint.
+        # @!attribute [rw] cases
+        #   @return [::Array<::Google::Cloud::Support::V2::Case>]
+        #     The list of cases associated with the Google Cloud Resource, after any
+        #     filters have been applied.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token to retrieve the next page of results. This should be set in the
+        #     `page_token` field of subsequent `SearchCaseRequest` message that is
+        #     issued. If unspecified, there are no more results to retrieve.
+        class SearchCasesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request message for the EscalateCase endpoint.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The fully qualified name of the Case resource to be escalated.
+        # @!attribute [rw] escalation
+        #   @return [::Google::Cloud::Support::V2::Escalation]
+        #     The escalation object to be sent with the escalation request.
+        class EscalateCaseRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request message for the UpdateCase endpoint
+        # @!attribute [rw] case
+        #   @return [::Google::Cloud::Support::V2::Case]
+        #     Required. The case object to update.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     A list of attributes of the case object that should be updated
+        #     as part of this request. Supported values are `priority`, `display_name`,
+        #     and `subscriber_email_addresses`. If no fields are specified, all supported
+        #     fields are updated.
+        #
+        #     WARNING: If you do not provide a field mask, then you might accidentally
+        #     clear some fields. For example, if you leave the field mask empty and do
+        #     not provide a value for `subscriber_email_addresses`, then
+        #     `subscriber_email_addresses` is updated to empty.
+        class UpdateCaseRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request message for the CloseCase endpoint.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The fully qualified name of the case resource to be closed.
+        class CloseCaseRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request message for SearchCaseClassifications endpoint.
+        # @!attribute [rw] query
+        #   @return [::String]
+        #     An expression written in the Google Cloud filter language. If non-empty,
+        #     then only cases whose fields match the filter are returned. If empty, then
+        #     no messages are filtered out.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     The maximum number of cases fetched with each request.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A token identifying the page of results to return. If unspecified, the
+        #     first page is retrieved.
+        class SearchCaseClassificationsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response message for SearchCaseClassifications endpoint.
+        # @!attribute [rw] case_classifications
+        #   @return [::Array<::Google::Cloud::Support::V2::CaseClassification>]
+        #     The classifications retrieved.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token to retrieve the next page of results. This should be set in the
+        #     `page_token` field of subsequent `SearchCaseClassificationsRequest` message
+        #     that is issued. If unspecified, there are no more results to retrieve.
+        class SearchCaseClassificationsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/support/v2/comment.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Support
+      module V2
+        # A comment associated with a support case.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The resource name for the comment.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time when this comment was created.
+        # @!attribute [r] creator
+        #   @return [::Google::Cloud::Support::V2::Actor]
+        #     Output only. The user or Google Support agent created this comment.
+        # @!attribute [rw] body
+        #   @return [::String]
+        #     The full comment body. Maximum of 12800 characters. This can contain rich
+        #     text syntax.
+        # @!attribute [r] plain_text_body
+        #   @return [::String]
+        #     Output only. DEPRECATED. An automatically generated plain text version of
+        #     body with all rich text syntax stripped.
+        class Comment
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/support/v2/comment_service.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Support
+      module V2
+        # The request message for the ListComments endpoint.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of Case object for which comments should be
+        #     listed.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     The maximum number of comments fetched with each request. Defaults to 10.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A token identifying the page of results to return. If unspecified, the
+        #     first page is retrieved.
+        class ListCommentsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response message for the ListComments endpoint.
+        # @!attribute [rw] comments
+        #   @return [::Array<::Google::Cloud::Support::V2::Comment>]
+        #     The list of Comments associated with the given Case.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token to retrieve the next page of results. This should be set in the
+        #     `page_token` field of subsequent `ListCommentsRequest` message that is
+        #     issued. If unspecified, there are no more results to retrieve.
+        class ListCommentsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request message for CreateComment endpoint.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of Case to which this comment should be added.
+        # @!attribute [rw] comment
+        #   @return [::Google::Cloud::Support::V2::Comment]
+        #     Required. The Comment object to be added to this Case.
+        class CreateCommentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/support/v2/escalation.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Support
+      module V2
+        # An escalation of a support case.
+        # @!attribute [rw] reason
+        #   @return [::Google::Cloud::Support::V2::Escalation::Reason]
+        #     Required. The reason why the Case is being escalated.
+        # @!attribute [rw] justification
+        #   @return [::String]
+        #     Required. A free text description to accompany the `reason` field above.
+        #     Provides additional context on why the case is being escalated.
+        class Escalation
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # An enum detailing the possible reasons a case may be escalated.
+          module Reason
+            # The escalation reason is in an unknown state or has not been specified.
+            REASON_UNSPECIFIED = 0
+
+            # The case is taking too long to resolve.
+            RESOLUTION_TIME = 1
+
+            # The support agent does not have the expertise required to successfully
+            # resolve the issue.
+            TECHNICAL_EXPERTISE = 2
+
+            # The issue is having a significant business impact.
+            BUSINESS_IMPACT = 3
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/protobuf/duration.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Protobuf
+    # A Duration represents a signed, fixed-length span of time represented
+    # as a count of seconds and fractions of seconds at nanosecond
+    # resolution. It is independent of any calendar and concepts like "day"
+    # or "month". It is related to Timestamp in that the difference between
+    # two Timestamp values is a Duration and it can be added or subtracted
+    # from a Timestamp. Range is approximately +-10,000 years.
+    #
+    # # Examples
+    #
+    # Example 1: Compute Duration from two Timestamps in pseudo code.
+    #
+    #     Timestamp start = ...;
+    #     Timestamp end = ...;
+    #     Duration duration = ...;
+    #
+    #     duration.seconds = end.seconds - start.seconds;
+    #     duration.nanos = end.nanos - start.nanos;
+    #
+    #     if (duration.seconds < 0 && duration.nanos > 0) {
+    #       duration.seconds += 1;
+    #       duration.nanos -= 1000000000;
+    #     } else if (duration.seconds > 0 && duration.nanos < 0) {
+    #       duration.seconds -= 1;
+    #       duration.nanos += 1000000000;
+    #     }
+    #
+    # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
+    #
+    #     Timestamp start = ...;
+    #     Duration duration = ...;
+    #     Timestamp end = ...;
+    #
+    #     end.seconds = start.seconds + duration.seconds;
+    #     end.nanos = start.nanos + duration.nanos;
+    #
+    #     if (end.nanos < 0) {
+    #       end.seconds -= 1;
+    #       end.nanos += 1000000000;
+    #     } else if (end.nanos >= 1000000000) {
+    #       end.seconds += 1;
+    #       end.nanos -= 1000000000;
+    #     }
+    #
+    # Example 3: Compute Duration from datetime.timedelta in Python.
+    #
+    #     td = datetime.timedelta(days=3, minutes=10)
+    #     duration = Duration()
+    #     duration.FromTimedelta(td)
+    #
+    # # JSON Mapping
+    #
+    # In JSON format, the Duration type is encoded as a string rather than an
+    # object, where the string ends in the suffix "s" (indicating seconds) and
+    # is preceded by the number of seconds, with nanoseconds expressed as
+    # fractional seconds. For example, 3 seconds with 0 nanoseconds should be
+    # encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
+    # be expressed in JSON format as "3.000000001s", and 3 seconds and 1
+    # microsecond should be expressed in JSON format as "3.000001s".
+    # @!attribute [rw] seconds
+    #   @return [::Integer]
+    #     Signed seconds of the span of time. Must be from -315,576,000,000
+    #     to +315,576,000,000 inclusive. Note: these bounds are computed from:
+    #     60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+    # @!attribute [rw] nanos
+    #   @return [::Integer]
+    #     Signed fractions of a second at nanosecond resolution of the span
+    #     of time. Durations less than one second are represented with a 0
+    #     `seconds` field and a positive or negative `nanos` field. For durations
+    #     of one second or more, a non-zero value for the `nanos` field must be
+    #     of the same sign as the `seconds` field. Must be from -999,999,999
+    #     to +999,999,999 inclusive.
+    class Duration
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end