google-cloud-support-v2 1.3.0 → 1.4.0

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

@@ -21,7 +21,33 @@ module Google
   module Cloud
     module Support
       module V2
-        # A support case.
+        # A Case is an object that contains the details of a support case. It
+        # contains fields for the time it was created, its priority, its
+        # classification, and more. Cases can also have comments and attachments that
+        # get added over time.
+        #
+        # A case is parented by a Google Cloud organization or project.
+        #
+        # Organizations are identified by a number, so the name of a case parented by
+        # an organization would look like this:
+        #
+        # ```
+        # organizations/123/cases/456
+        # ```
+        #
+        # Projects have two unique identifiers, an ID and a number, and they look like
+        # this:
+        #
+        # ```
+        # projects/abc/cases/456
+        # ```
+        #
+        # ```
+        # projects/123/cases/456
+        # ```
+        #
+        # You can use either of them when calling the API. To learn more
+        # about project identifiers, see [AIP-2510](https://google.aip.dev/cloud/2510).
         # @!attribute [rw] name
         #   @return [::String]
         #     The resource name for the case.
@@ -132,16 +158,29 @@ module Google
           end
         end
 
-        # A classification object with a product type and value.
+        # A Case Classification represents the topic that a case is about. It's very
+        # important to use accurate classifications, because they're
+        # used to route your cases to specialists who can help you.
+        #
+        # A classification always has an ID that is its unique identifier.
+        # A valid ID is required when creating a case.
         # @!attribute [rw] id
         #   @return [::String]
         #     The unique ID for a classification. Must be specified for case creation.
         #
         #     To retrieve valid classification IDs for case creation, use
         #     `caseClassifications.search`.
+        #
+        #     Classification IDs returned by `caseClassifications.search` are guaranteed
+        #     to be valid for at least 6 months. If a given classification is
+        #     deactiveated, it will immediately stop being returned. After 6 months,
+        #     `case.create` requests using the classification ID will fail.
         # @!attribute [rw] display_name
         #   @return [::String]
-        #     The display name of the classification.
+        #     A display name for the classification.
+        #
+        #     The display name is not static and can change. To uniquely and consistently
+        #     identify classifications, use the `CaseClassification.id` field.
         class CaseClassification
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -24,7 +24,7 @@ module Google
         # The request message for the GetCase endpoint.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. The fully qualified name of a case to be retrieved.
+        #     Required. The full name of a case to be retrieved.
         class GetCaseRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -33,8 +33,7 @@ module Google
         # 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.
+        #     Required. The name of the parent under which the case should be created.
         # @!attribute [rw] case
         #   @return [::Google::Cloud::Support::V2::Case]
         #     Required. The case to be created.
@@ -46,22 +45,24 @@ module Google
         # The request message for the ListCases endpoint.
         # @!attribute [rw] parent
         #   @return [::String]
-        #     Required. The fully qualified name of parent resource to list cases under.
+        #     Required. The name of a parent 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.
+        #     An expression used to filter cases.
         #
-        #     Filter expressions use the following fields with the operators equals (`=`)
-        #     and `AND`:
+        #     If it's an empty string, then no filtering happens. Otherwise, the endpoint
+        #     returns the cases that match the filter.
         #
-        #     - `state`: The accepted values are `OPEN` or `CLOSED`.
-        #     - `priority`: The accepted values are `P0`, `P1`, `P2`, `P3`, or `P4`. You
+        #     Expressions use the following fields separated by `AND` and specified with
+        #     `=`:
+        #
+        #     - `state`: Can be `OPEN` or `CLOSED`.
+        #     - `priority`: Can be `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:
+        #     EXAMPLES:
         #
         #     - `state=CLOSED`
         #     - `state=OPEN AND creator.email="tester@example.com"`
@@ -81,13 +82,13 @@ module Google
         # 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
+        #     The list of cases associated with the parent 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.
+        #     A token to retrieve the next page of results. Set this in the `page_token`
+        #     field of subsequent `cases.list` requests. If unspecified, there are no
+        #     more results to retrieve.
         class ListCasesResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -96,24 +97,22 @@ module Google
         # The request message for the SearchCases endpoint.
         # @!attribute [rw] parent
         #   @return [::String]
-        #     The fully qualified name of parent resource to search cases under.
+        #     The name of the parent resource to search for cases under.
         # @!attribute [rw] query
         #   @return [::String]
-        #     An expression written in filter language.
+        #     An expression used to filter cases.
         #
-        #     A query uses the following fields with the operators equals (`=`) and
-        #     `AND`:
+        #     Expressions use the following fields separated by `AND` and specified with
+        #     `=`:
         #
         #     - `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
+        #     - `state`: Can be `OPEN` or `CLOSED`.
+        #     - `priority`: Can be `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`.
         #
@@ -130,7 +129,6 @@ module Google
         #     - `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)`
@@ -150,13 +148,13 @@ module Google
         # 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
+        #     The list of cases associated with the parent 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.
+        #     A token to retrieve the next page of results. Set this in the
+        #     `page_token` field of subsequent `cases.search` requests. If unspecified,
+        #     there are no more results to retrieve.
         class SearchCasesResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -165,10 +163,10 @@ module Google
         # The request message for the EscalateCase endpoint.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. The fully qualified name of the Case resource to be escalated.
+        #     Required. The name of the case to be escalated.
         # @!attribute [rw] escalation
         #   @return [::Google::Cloud::Support::V2::Escalation]
-        #     The escalation object to be sent with the escalation request.
+        #     The escalation information to be sent with the escalation request.
         class EscalateCaseRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -177,17 +175,16 @@ module Google
         # The request message for the UpdateCase endpoint
         # @!attribute [rw] case
         #   @return [::Google::Cloud::Support::V2::Case]
-        #     Required. The case object to update.
+        #     Required. The case 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.
+        #     A list of attributes of the case that should be updated. 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
+        #     Be careful - 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
@@ -197,21 +194,22 @@ module Google
         # The request message for the CloseCase endpoint.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. The fully qualified name of the case resource to be closed.
+        #     Required. The name of the case to close.
         class CloseCaseRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The request message for SearchCaseClassifications endpoint.
+        # The request message for the 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.
+        #     An expression used to filter case classifications.
+        #
+        #     If it's an empty string, then no filtering happens. Otherwise, case
+        #     classifications will be returned that match the filter.
         # @!attribute [rw] page_size
         #   @return [::Integer]
-        #     The maximum number of cases fetched with each request.
+        #     The maximum number of classifications fetched with each request.
         # @!attribute [rw] page_token
         #   @return [::String]
         #     A token identifying the page of results to return. If unspecified, the
@@ -227,9 +225,9 @@ module Google
         #     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.
+        #     A token to retrieve the next page of results. Set this in the `page_token`
+        #     field of subsequent `caseClassifications.list` requests. If unspecified,
+        #     there are no more results to retrieve.
         class SearchCaseClassificationsResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -22,23 +22,32 @@ module Google
     module Support
       module V2
         # A comment associated with a support case.
+        #
+        # Case comments are the primary way for Google Support to communicate with a
+        # user who has opened a case. When a user responds to Google Support, the
+        # user's responses also appear as comments.
         # @!attribute [r] name
         #   @return [::String]
-        #     Output only. The resource name for the comment.
+        #     Output only. Identifier. The resource name of the comment.
         # @!attribute [r] create_time
         #   @return [::Google::Protobuf::Timestamp]
-        #     Output only. The time when this comment was created.
+        #     Output only. The time when the comment was created.
         # @!attribute [r] creator
         #   @return [::Google::Cloud::Support::V2::Actor]
-        #     Output only. The user or Google Support agent created this comment.
+        #     Output only. The user or Google Support agent who created the comment.
         # @!attribute [rw] body
         #   @return [::String]
-        #     The full comment body. Maximum of 12800 characters. This can contain rich
-        #     text syntax.
+        #     The full comment body.
+        #
+        #     Maximum of 12800 characters.
         # @!attribute [r] plain_text_body
+        #   @deprecated This field is deprecated and may be removed in the next major version update.
         #   @return [::String]
-        #     Output only. DEPRECATED. An automatically generated plain text version of
-        #     body with all rich text syntax stripped.
+        #     Output only. DEPRECATED. DO NOT USE.
+        #
+        #     A duplicate of the `body` field.
+        #
+        #     This field is only present for legacy reasons.
         class Comment
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -24,15 +24,14 @@ module Google
         # 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.
+        #     Required. The name of the case for which to list comments.
         # @!attribute [rw] page_size
         #   @return [::Integer]
-        #     The maximum number of comments fetched with each request. Defaults to 10.
+        #     The maximum number of comments to fetch. 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.
+        #     first page is returned.
         class ListCommentsRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -41,24 +40,24 @@ module Google
         # 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.
+        #     List of the comments associated with the 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.
+        #     A token to retrieve the next page of results. Set this in the `page_token`
+        #     field of subsequent `cases.comments.list` requests. 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.
+        # The request message for the CreateComment endpoint.
         # @!attribute [rw] parent
         #   @return [::String]
-        #     Required. The resource name of Case to which this comment should be added.
+        #     Required. The name of the case to which the comment should be added.
         # @!attribute [rw] comment
         #   @return [::Google::Cloud::Support::V2::Comment]
-        #     Required. The Comment object to be added to this Case.
+        #     Required. The comment to be added.
         class CreateCommentRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-support-v2
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Google LLC