Skip to content

Commit

Permalink
feat(cloudsupport): update the api
Browse files Browse the repository at this point in the history
#### cloudsupport:v2

The following keys were added:
- schemas.Actor.properties.email.deprecated (Total Keys: 1)
- schemas.Actor.properties.username (Total Keys: 2)

#### cloudsupport:v2beta

The following keys were added:
- schemas.Actor.properties.email.deprecated (Total Keys: 1)
- schemas.Actor.properties.username (Total Keys: 2)
  • Loading branch information
yoshi-automation committed Jan 4, 2024
1 parent 6414ab0 commit eeaa29c
Show file tree
Hide file tree
Showing 12 changed files with 166 additions and 124 deletions.
2 changes: 1 addition & 1 deletion docs/dyn/cloudsupport_v2.caseClassifications.html
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ <h3>Method Details</h3>

{ # The response message for SearchCaseClassifications endpoint.
&quot;caseClassifications&quot;: [ # The classifications retrieved.
{ # A classification object with a product type and value.
{ # A Case Classification represents the topic that a case is about. It&#x27;s very important to use accurate classifications, because they&#x27;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.
&quot;displayName&quot;: &quot;A String&quot;, # 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.
&quot;id&quot;: &quot;A String&quot;, # 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.
},
Expand Down
7 changes: 4 additions & 3 deletions docs/dyn/cloudsupport_v2.cases.attachments.html
Original file line number Diff line number Diff line change
Expand Up @@ -107,12 +107,13 @@ <h3>Method Details</h3>

{ # The response message for the ListAttachments endpoint.
&quot;attachments&quot;: [ # The list of attachments associated with a case.
{ # Represents a file attached to a support case.
{ # An Attachment contains metadata about a file that was uploaded to a case - it is NOT a file itself. That being said, the name of an Attachment object can be used to download its accompanying file through the `media.download` endpoint. While attachments can be uploaded in the console at the same time as a comment, they&#x27;re associated on a &quot;case&quot; level, not a &quot;comment&quot; level.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which the attachment was created.
&quot;creator&quot;: { # An object containing information about the effective user and authenticated principal responsible for an action. # Output only. The user who uploaded the attachment. Note, the name and email will be obfuscated if the attachment was uploaded by Google support.
&quot;creator&quot;: { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # Output only. The user who uploaded the attachment. Note, the name and email will be obfuscated if the attachment was uploaded by Google support.
&quot;displayName&quot;: &quot;A String&quot;, # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent.
&quot;email&quot;: &quot;A String&quot;, # The email address of the actor. If not provided, it is inferred from credentials supplied during case creation. If the authenticated principal does not have an email address, one must be provided. When a name is provided, an email must also be provided. This will be obfuscated if the user is a Google Support agent.
&quot;email&quot;: &quot;A String&quot;, # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use **username** field instead.
&quot;googleSupport&quot;: True or False, # Output only. Whether the actor is a Google support actor.
&quot;username&quot;: &quot;A String&quot;, # Output only. The username of the actor. It may look like an email or other format provided by the identity provider. If not provided, it is inferred from the credentials supplied. When a name is provided, a username must also be provided. If the user is a Google Support agent, this will not be set.
},
&quot;filename&quot;: &quot;A String&quot;, # The filename of the attachment (e.g. `&quot;graph.jpg&quot;`).
&quot;mimeType&quot;: &quot;A String&quot;, # Output only. The MIME type of the attachment (e.g. text/plain).
Expand Down
21 changes: 12 additions & 9 deletions docs/dyn/cloudsupport_v2.cases.comments.html
Original file line number Diff line number Diff line change
Expand Up @@ -101,13 +101,14 @@ <h3>Method Details</h3>
body: object, The request body.
The object takes the form of:

{ # A comment associated with a support case.
{ # Case comments are the main way Google Support communicates with a user who has opened a case. When a user responds to Google Support, the user&#x27;s responses also appear as comments.
&quot;body&quot;: &quot;A String&quot;, # The full comment body. Maximum of 12800 characters. This can contain rich text syntax.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when this comment was created.
&quot;creator&quot;: { # An object containing information about the effective user and authenticated principal responsible for an action. # Output only. The user or Google Support agent created this comment.
&quot;creator&quot;: { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # Output only. The user or Google Support agent created this comment.
&quot;displayName&quot;: &quot;A String&quot;, # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent.
&quot;email&quot;: &quot;A String&quot;, # The email address of the actor. If not provided, it is inferred from credentials supplied during case creation. If the authenticated principal does not have an email address, one must be provided. When a name is provided, an email must also be provided. This will be obfuscated if the user is a Google Support agent.
&quot;email&quot;: &quot;A String&quot;, # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use **username** field instead.
&quot;googleSupport&quot;: True or False, # Output only. Whether the actor is a Google support actor.
&quot;username&quot;: &quot;A String&quot;, # Output only. The username of the actor. It may look like an email or other format provided by the identity provider. If not provided, it is inferred from the credentials supplied. When a name is provided, a username must also be provided. If the user is a Google Support agent, this will not be set.
},
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for the comment.
&quot;plainTextBody&quot;: &quot;A String&quot;, # Output only. DEPRECATED. An automatically generated plain text version of body with all rich text syntax stripped.
Expand All @@ -121,13 +122,14 @@ <h3>Method Details</h3>
Returns:
An object of the form:

{ # A comment associated with a support case.
{ # Case comments are the main way Google Support communicates with a user who has opened a case. When a user responds to Google Support, the user&#x27;s responses also appear as comments.
&quot;body&quot;: &quot;A String&quot;, # The full comment body. Maximum of 12800 characters. This can contain rich text syntax.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when this comment was created.
&quot;creator&quot;: { # An object containing information about the effective user and authenticated principal responsible for an action. # Output only. The user or Google Support agent created this comment.
&quot;creator&quot;: { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # Output only. The user or Google Support agent created this comment.
&quot;displayName&quot;: &quot;A String&quot;, # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent.
&quot;email&quot;: &quot;A String&quot;, # The email address of the actor. If not provided, it is inferred from credentials supplied during case creation. If the authenticated principal does not have an email address, one must be provided. When a name is provided, an email must also be provided. This will be obfuscated if the user is a Google Support agent.
&quot;email&quot;: &quot;A String&quot;, # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use **username** field instead.
&quot;googleSupport&quot;: True or False, # Output only. Whether the actor is a Google support actor.
&quot;username&quot;: &quot;A String&quot;, # Output only. The username of the actor. It may look like an email or other format provided by the identity provider. If not provided, it is inferred from the credentials supplied. When a name is provided, a username must also be provided. If the user is a Google Support agent, this will not be set.
},
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for the comment.
&quot;plainTextBody&quot;: &quot;A String&quot;, # Output only. DEPRECATED. An automatically generated plain text version of body with all rich text syntax stripped.
Expand All @@ -152,13 +154,14 @@ <h3>Method Details</h3>

{ # The response message for the ListComments endpoint.
&quot;comments&quot;: [ # List of the comments associated with the case.
{ # A comment associated with a support case.
{ # Case comments are the main way Google Support communicates with a user who has opened a case. When a user responds to Google Support, the user&#x27;s responses also appear as comments.
&quot;body&quot;: &quot;A String&quot;, # The full comment body. Maximum of 12800 characters. This can contain rich text syntax.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when this comment was created.
&quot;creator&quot;: { # An object containing information about the effective user and authenticated principal responsible for an action. # Output only. The user or Google Support agent created this comment.
&quot;creator&quot;: { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # Output only. The user or Google Support agent created this comment.
&quot;displayName&quot;: &quot;A String&quot;, # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent.
&quot;email&quot;: &quot;A String&quot;, # The email address of the actor. If not provided, it is inferred from credentials supplied during case creation. If the authenticated principal does not have an email address, one must be provided. When a name is provided, an email must also be provided. This will be obfuscated if the user is a Google Support agent.
&quot;email&quot;: &quot;A String&quot;, # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use **username** field instead.
&quot;googleSupport&quot;: True or False, # Output only. Whether the actor is a Google support actor.
&quot;username&quot;: &quot;A String&quot;, # Output only. The username of the actor. It may look like an email or other format provided by the identity provider. If not provided, it is inferred from the credentials supplied. When a name is provided, a username must also be provided. If the user is a Google Support agent, this will not be set.
},
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for the comment.
&quot;plainTextBody&quot;: &quot;A String&quot;, # Output only. DEPRECATED. An automatically generated plain text version of body with all rich text syntax stripped.
Expand Down

0 comments on commit eeaa29c

Please sign in to comment.