google-apis-cloudsupport_v2 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8428da806093b08571631ddb3f6b0cb522f7629d0b883c1d7a609e5e6af6057d
-  data.tar.gz: afc7b1b3186198a47522d403d0bb56d499918bf760235ed4b5633141e5372a08
+  metadata.gz: 9e71bf8078540186c463d7806e543dc506dec619582dd2dffeef5ad3ba1568b8
+  data.tar.gz: e49e75175d1e926e2f91e9c6a295a6a7cdce8270c0c80bd1545992cc53ab4ab8
 SHA512:
-  metadata.gz: bebfeb05a60ae3407370943d7723f6690fc14edd814e12d618383fb5707da57daf42d1877d3edd1b7b710c3b5574a5fd31dd2b65ce5a4e9d91b62dae2a772583
-  data.tar.gz: 3a976b71aa49e1cade7a3ebdb4f043c8dd749403281f5b02c6cf827c42173c33ffe6cf42d1794890a5525f39fc55fed168e59bfdd5ca4fa2ca2fb8639bb6162d
+  metadata.gz: 1c08c3bde964244b221e8f68863bd7146454c4571281e7f4f6f59fe4b4bf77fa0e2ee09de8018eb627fc5a39999f968bfb039bc67336add106f196782e4626e7
+  data.tar.gz: db504c2fde0cf65eca87bdd05160ce5c5efff0955b5f07443cfc35b91cc60a6cb74156875fd92b990811ea09a52963baeab01c99a1502d02c2123dd96cc0db61

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-cloudsupport_v2
 
+### v0.3.0 (2023-08-27)
+
+* Regenerated from discovery document revision 20230818
+
+### v0.2.0 (2023-08-03)
+
+* Regenerated from discovery document revision 20230725
+
 ### v0.1.0 (2023-07-02)
 
 * Regenerated from discovery document revision 20230626

data/lib/google/apis/cloudsupport_v2/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module CloudsupportV2
       # Version of the google-apis-cloudsupport_v2 gem
-      GEM_VERSION = "0.1.0"
+      GEM_VERSION = "0.3.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.12.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20230626"
+      REVISION = "20230818"
     end
   end
 end

data/lib/google/apis/cloudsupport_v2/service.rb

@@ -54,10 +54,13 @@ module Google
         # classications are hierarchical, with each classification containing all levels
         # of the hierarchy, separated by `" > "`. For example `"Technical Issue >
         # Compute > Compute Engine"`. 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.
+        # caseClassifications.search` are guaranteed to be valid for at least six months.
+        # If a given classification is deactivated, it immediately stops being returned.
+        # After six months, `case.create` requests using the classification ID will
+        # fail. Here is an example of calling this endpoint using cURL: ```shell curl \ -
+        # -header "Authorization: Bearer $(gcloud auth print-access-token)" \ 'https://
+        # cloudsupport.googleapis.com/v2/caseClassifications:search?query=display_name:"*
+        # Compute%20Engine*"' ```
         # @param [Fixnum] page_size
         #   The maximum number of cases fetched with each request.
         # @param [String] page_token
@@ -96,7 +99,10 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Close the specified case.
+        # Close the specified case. Here is an example of calling this endpoint using
+        # cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request
+        # POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "
+        # https://cloudsupport.googleapis.com/v2/$case:close" ```
         # @param [String] name
         #   Required. The fully qualified name of the case resource to be closed.
         # @param [Google::Apis::CloudsupportV2::CloseCaseRequest] close_case_request_object
@@ -129,9 +135,19 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Create a new case and associate it with the given Google Cloud Resource. The
-        # case object must have the following fields set: `display_name`, `description`,
-        # `classification`, and `priority`.
+        # Create a new case and associate it with a Google Cloud Resource. The case
+        # object must have the following fields set: `display_name`, `description`, `
+        # classification`, and `priority`. If you're just testing the API and don't want
+        # to route your case to an agent, set `testCase=true`. Here is an example of
+        # calling this endpoint using cURL: ```shell parent="projects/some-project" curl
+        # \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-
+        # token)" \ --header 'Content-Type: application/json' \ --data '` "display_name":
+        # "Test case created by me.", "description": "a random test case, feel free to
+        # close", "classification": ` "id": "
+        # 1BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8"
+        # `, "time_zone": "-07:00", "subscriber_email_addresses": [ "foo@domain.com", "
+        # bar@domain.com" ], "testCase": true, "priority": "P3" `' \ "https://
+        # cloudsupport.googleapis.com/v2/$parent/cases" ```
         # @param [String] parent
         #   Required. The name of the Google Cloud Resource under which the case should be
         #   created.
@@ -165,11 +181,16 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Escalate a case. Escalating a case will initiate the Google Cloud Support
+        # Escalate a case. Escalating a case initiates the Google Cloud Support
         # escalation management process. This operation is only available to certain
-        # Customer Care tiers. Go to https://cloud.google.com/support and look for '
-        # Technical support escalations' in the feature list to find out which tiers are
-        # able to perform escalations.
+        # Customer Care support services. Go to https://cloud.google.com/support and
+        # look for 'Technical support escalations' in the feature list to find out which
+        # support services let you perform escalations. Here is an example of calling
+        # this endpoint using cURL: ```shell case="projects/some-project/cases/43595344"
+        # curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-
+        # access-token)" \ --header "Content-Type: application/json" \ --data '` "
+        # escalation": ` "reason": "BUSINESS_IMPACT", "justification": "This is a test
+        # escalation." ` `' \ "https://cloudsupport.googleapis.com/v2/$case:escalate" ```
         # @param [String] name
         #   Required. The fully qualified name of the Case resource to be escalated.
         # @param [Google::Apis::CloudsupportV2::EscalateCaseRequest] escalate_case_request_object
@@ -202,7 +223,10 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieve the specified case.
+        # Retrieve the specified case. Here is an example of calling this endpoint using
+        # cURL: ```shell case="projects/some-project/cases/16033687" curl \ --header "
+        # Authorization: Bearer $(gcloud auth print-access-token)" \ "https://
+        # cloudsupport.googleapis.com/v2/$case" ```
         # @param [String] name
         #   Required. The fully qualified name of a case to be retrieved.
         # @param [String] fields
@@ -233,9 +257,12 @@ module Google
         end
         
         # Retrieve all cases under the specified parent. Note: Listing cases under an
-        # Organization returns only the cases directly parented by that organization. To
+        # organization returns only the cases directly parented by that organization. To
         # retrieve all cases under an organization, including cases parented by projects
-        # under that organization, use `cases.search`.
+        # under that organization, use `cases.search`. Here is an example of calling
+        # this endpoint using cURL: ```shell parent="projects/some-project" curl \ --
+        # header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://
+        # cloudsupport.googleapis.com/v2/$parent/cases" ```
         # @param [String] parent
         #   Required. The fully qualified name of parent resource to list cases under.
         # @param [String] filter
@@ -283,7 +310,12 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Update the specified case. Only a subset of fields can be updated.
+        # Update the specified case. Only a subset of fields can be updated. Here is an
+        # example of calling this endpoint using cURL: ```shell case="projects/some-
+        # project/cases/43595344" curl \ --request PATCH \ --header "Authorization:
+        # Bearer $(gcloud auth print-access-token)" \ --header "Content-Type:
+        # application/json" \ --data '` "priority": "P1" `' \ "https://cloudsupport.
+        # googleapis.com/v2/$case?updateMask=priority" ```
         # @param [String] name
         #   The resource name for the case.
         # @param [Google::Apis::CloudsupportV2::Case] case_object
@@ -325,7 +357,10 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Search cases using the specified query.
+        # Search cases using the specified query. Here is an example of calling this
+        # endpoint using cURL: ```shell parent="projects/some-project" curl \ --header "
+        # Authorization: Bearer $(gcloud auth print-access-token)" \ "https://
+        # cloudsupport.googleapis.com/v2/$parent/cases:search" ```
         # @param [String] parent
         #   The fully qualified name of parent resource to search cases under.
         # @param [Fixnum] page_size
@@ -385,7 +420,10 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieve all attachments associated with a support case.
+        # Retrieve all attachments associated with a support case. Here is an example of
+        # calling this endpoint using cURL: ```shell case="projects/some-project/cases/
+        # 23598314" curl \ --header "Authorization: Bearer $(gcloud auth print-access-
+        # token)" \ "https://cloudsupport.googleapis.com/v2/$case/attachments" ```
         # @param [String] parent
         #   Required. The resource name of Case object for which attachments should be
         #   listed.
@@ -425,7 +463,11 @@ module Google
         end
         
         # Add a new comment to the specified Case. The comment object must have the
-        # following fields set: body.
+        # following fields set: body. Here is an example of calling this endpoint using
+        # cURL: ```shell case="projects/some-project/cases/43591344" curl \ --request
+        # POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --
+        # header 'Content-Type: application/json' \ --data '` "body": "This is a test
+        # comment." `' \ "https://cloudsupport.googleapis.com/v2/$case/comments" ```
         # @param [String] parent
         #   Required. The resource name of Case to which this comment should be added.
         # @param [Google::Apis::CloudsupportV2::Comment] comment_object
@@ -458,7 +500,11 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieve all Comments associated with the Case object.
+        # Retrieve all comments associated with the Case object. Here is an example of
+        # calling this endpoint using cURL: ```shell case="projects/cloud-support-qa-
+        # premium/cases/43595344" curl \ --header "Authorization: Bearer $(gcloud auth
+        # print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/comments"
+        # ```
         # @param [String] parent
         #   Required. The resource name of Case object for which comments should be listed.
         # @param [Fixnum] page_size
@@ -496,7 +542,11 @@ module Google
         end
         
         # Download a file attachment on a case. Note: HTTP requests must append "?alt=
-        # media" to the URL.
+        # media" to the URL. Here is an example of calling this endpoint using cURL: ```
+        # shell name="projects/some-project/cases/43594844/attachments/
+        # 0674M00000WijAnZAJ" curl \ --header "Authorization: Bearer $(gcloud auth print-
+        # access-token)" \ "https://cloudsupport.googleapis.com/v2/$name:download?alt=
+        # media" ```
         # @param [String] name
         #   The resource name of the attachment to be downloaded.
         # @param [String] fields
@@ -534,7 +584,13 @@ module Google
         end
         
         # Create a file attachment on a case or Cloud resource. The attachment object
-        # must have the following fields set: filename.
+        # must have the following fields set: filename. Here is an example of calling
+        # this endpoint using cURL: ```shell echo "This text is in a file I'm uploading
+        # using CSAPI." \ > "./example_file.txt" case="projects/some-project/cases/
+        # 43594844" curl \ --header "Authorization: Bearer $(gcloud auth print-access-
+        # token)" \ --data-binary @"./example_file.txt" \ "https://cloudsupport.
+        # googleapis.com/upload/v2beta/$case/attachments?attachment.filename=
+        # uploaded_via_curl.txt" ```
         # @param [String] parent
         #   Required. The resource name of the case (or case parent) to which the
         #   attachment should be attached.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-cloudsupport_v2
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-02 00:00:00.000000000 Z
+date: 2023-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-cloudsupport_v2/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-cloudsupport_v2/v0.1.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-cloudsupport_v2/v0.3.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-cloudsupport_v2
 post_install_message: 
 rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.2
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Simple REST client for Google Cloud Support API V2