@maxim_mazurok/gapi.client.cloudsupport-v2 0.0.20230724 → 0.0.20230725

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://cloudsupport.googleapis.com/$discovery/rest?version=v2
-// Revision: 20230724
+// Revision: 20230725
 
 /// <reference types="gapi.client" />
 
@@ -512,7 +512,10 @@ declare namespace gapi.client {
             }): Request<SearchCaseClassificationsResponse>;
         }
         interface AttachmentsResource {
-            /** 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" ```
+             */
             list(request?: {
                 /** V1 error format. */
                 "$.xgafv"?:
@@ -559,7 +562,11 @@ declare namespace gapi.client {
             }): Request<ListAttachmentsResponse>;
         }
         interface CommentsResource {
-            /** Add a new comment to the specified Case. The comment object must have the following fields set: body. */
+            /**
+             * Add a new comment to the specified Case. The comment object must have the 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" ```
+             */
             create(request: {
                 /** V1 error format. */
                 "$.xgafv"?:
@@ -640,7 +647,10 @@ declare namespace gapi.client {
                     string;
             },
             body: Comment): Request<Comment>;
-            /** 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" ```
+             */
             list(request?: {
                 /** V1 error format. */
                 "$.xgafv"?:
@@ -688,7 +698,7 @@ declare namespace gapi.client {
         }
         interface CasesResource {
             /**
-             * Close the specified case. Here is an example of calling this endpoint using cURL: ```shell case="projects/cloud-support-qa-premium/cases/43595344" curl \ --request POST \ --header
+             * 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" ```
              */
             close(request: {
@@ -1210,7 +1220,11 @@ declare namespace gapi.client {
                 CommentsResource;
         }
         interface MediaResource {
-            /** Download a file attachment on a case. Note: HTTP requests must append "?alt=media" to the URL. */
+            /**
+             * Download a file attachment on a case. Note: HTTP requests must append "?alt=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" ```
+             */
             download(request?: {
                 /** V1 error format. */
                 "$.xgafv"?:
@@ -1249,7 +1263,12 @@ declare namespace gapi.client {
                 uploadType?:
                     string;
             }): Request<Media>;
-            /** Create a file attachment on a case or Cloud resource. The attachment object must have the following fields set: filename. */
+            /**
+             * Create a file attachment on a case or Cloud resource. The attachment object 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" ```
+             */
             upload(request: {
                 /** V1 error format. */
                 "$.xgafv"?:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.cloudsupport-v2",
-  "version": "0.0.20230724",
+  "version": "0.0.20230725",
   "description": "TypeScript typings for Google Cloud Support API v2",
   "license": "MIT",
   "author": {

package/readme.md

@@ -72,7 +72,7 @@ Retrieve valid classifications to be used when creating a support case. The clas
 await gapi.client.cloudsupport.caseClassifications.search({  });
 
 /*
-Close the specified case. Here is an example of calling this endpoint using cURL: ```shell case="projects/cloud-support-qa-premium/cases/43595344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case:close" ```
+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" ```
 */
 await gapi.client.cloudsupport.cases.close({ name: "name",  });
 
@@ -107,12 +107,12 @@ Search cases using the specified query. Here is an example of calling this endpo
 await gapi.client.cloudsupport.cases.search({ parent: "parent",  });
 
 /*
-Download a file attachment on a case. Note: HTTP requests must append "?alt=media" to the URL.
+Download a file attachment on a case. Note: HTTP requests must append "?alt=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" ```
 */
 await gapi.client.cloudsupport.media.download({ name: "name",  });
 
 /*
-Create a file attachment on a case or Cloud resource. The attachment object must have the following fields set: filename.
+Create a file attachment on a case or Cloud resource. The attachment object 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" ```
 */
 await gapi.client.cloudsupport.media.upload({ parent: "parent",  });
 ```

package/tests.ts

@@ -3,7 +3,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 
-// Revision: 20230724
+// Revision: 20230725
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -42,8 +42,8 @@ gapi.load('client', async () => {
             query: "Test string",
         });
         /**
-         * Close the specified case. Here is an example of calling this endpoint using cURL: ```shell case="projects/cloud-support-qa-premium/cases/43595344" curl \ --request POST \ --header
-         * "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case:close" ```
+         * 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" ```
          */
         await gapi.client.cloudsupport.cases.close({
             name: "Test string",
@@ -161,13 +161,20 @@ gapi.load('client', async () => {
             parent: "Test string",
             query: "Test string",
         });
-        /** 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" ```
+         */
         await gapi.client.cloudsupport.cases.attachments.list({
             pageSize: 42,
             pageToken: "Test string",
             parent: "Test string",
         });
-        /** Add a new comment to the specified Case. The comment object must have the following fields set: body. */
+        /**
+         * Add a new comment to the specified Case. The comment object must have the 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" ```
+         */
         await gapi.client.cloudsupport.cases.comments.create({
             parent: "Test string",
         }, {
@@ -181,17 +188,28 @@ gapi.load('client', async () => {
             name: "Test string",
             plainTextBody: "Test string",
         });
-        /** 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" ```
+         */
         await gapi.client.cloudsupport.cases.comments.list({
             pageSize: 42,
             pageToken: "Test string",
             parent: "Test string",
         });
-        /** Download a file attachment on a case. Note: HTTP requests must append "?alt=media" to the URL. */
+        /**
+         * Download a file attachment on a case. Note: HTTP requests must append "?alt=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" ```
+         */
         await gapi.client.cloudsupport.media.download({
             name: "Test string",
         });
-        /** Create a file attachment on a case or Cloud resource. The attachment object must have the following fields set: filename. */
+        /**
+         * Create a file attachment on a case or Cloud resource. The attachment object 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" ```
+         */
         await gapi.client.cloudsupport.media.upload({
             parent: "Test string",
         }, {