@maxim_mazurok/gapi.client.cloudsupport-v2 0.0.20230822 → 0.0.20230904
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +40 -31
- package/package.json +1 -1
- package/readme.md +2 -2
- package/tests.ts +26 -13
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://cloudsupport.googleapis.com/$discovery/rest?version=v2
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20230904
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -290,12 +290,12 @@ declare namespace gapi.client {
|
|
|
290
290
|
string;
|
|
291
291
|
}
|
|
292
292
|
interface ListAttachmentsResponse {
|
|
293
|
-
/** The list of attachments associated with
|
|
293
|
+
/** The list of attachments associated with a case. */
|
|
294
294
|
attachments?:
|
|
295
295
|
Attachment[];
|
|
296
296
|
/**
|
|
297
|
-
* A token to retrieve the next page of results.
|
|
298
|
-
*
|
|
297
|
+
* A token to retrieve the next page of results. Set this in the `page_token` field of subsequent `cases.attachments.list` requests. If unspecified, there are no more results to
|
|
298
|
+
* retrieve.
|
|
299
299
|
*/
|
|
300
300
|
nextPageToken?:
|
|
301
301
|
string;
|
|
@@ -312,13 +312,10 @@ declare namespace gapi.client {
|
|
|
312
312
|
string;
|
|
313
313
|
}
|
|
314
314
|
interface ListCommentsResponse {
|
|
315
|
-
/**
|
|
315
|
+
/** List of the comments associated with the case. */
|
|
316
316
|
comments?:
|
|
317
317
|
Comment[];
|
|
318
|
-
/**
|
|
319
|
-
* 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
|
|
320
|
-
* more results to retrieve.
|
|
321
|
-
*/
|
|
318
|
+
/** 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. */
|
|
322
319
|
nextPageToken?:
|
|
323
320
|
string;
|
|
324
321
|
}
|
|
@@ -513,8 +510,10 @@ declare namespace gapi.client {
|
|
|
513
510
|
}
|
|
514
511
|
interface AttachmentsResource {
|
|
515
512
|
/**
|
|
516
|
-
*
|
|
517
|
-
*
|
|
513
|
+
* List all the attachments associated with a support case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/23598314" curl \ --header "Authorization: Bearer $(gcloud auth
|
|
514
|
+
* print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/attachments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService =
|
|
515
|
+
* googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", )
|
|
516
|
+
* request = ( supportApiService.cases() .attachments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```
|
|
518
517
|
*/
|
|
519
518
|
list(request?: {
|
|
520
519
|
/** V1 error format. */
|
|
@@ -544,7 +543,7 @@ declare namespace gapi.client {
|
|
|
544
543
|
/** A token identifying the page of results to return. If unspecified, the first page is retrieved. */
|
|
545
544
|
pageToken?:
|
|
546
545
|
string;
|
|
547
|
-
/** Required. The
|
|
546
|
+
/** Required. The name of the case for which attachments should be listed. */
|
|
548
547
|
parent:
|
|
549
548
|
string;
|
|
550
549
|
/** Returns response with indentations and line breaks. */
|
|
@@ -563,9 +562,11 @@ declare namespace gapi.client {
|
|
|
563
562
|
}
|
|
564
563
|
interface CommentsResource {
|
|
565
564
|
/**
|
|
566
|
-
* Add a new comment to
|
|
567
|
-
*
|
|
568
|
-
*
|
|
565
|
+
* Add a new comment to a case. The comment must have the following fields set: `body`. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43591344" curl \ --request POST \
|
|
566
|
+
* --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "body": "This is a test comment." }' \
|
|
567
|
+
* "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService =
|
|
568
|
+
* googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", )
|
|
569
|
+
* request = ( supportApiService.cases() .comments() .create( parent="projects/some-project/cases/43595344", body={"body": "This is a test comment."}, ) ) print(request.execute()) ```
|
|
569
570
|
*/
|
|
570
571
|
create(request: {
|
|
571
572
|
/** V1 error format. */
|
|
@@ -589,7 +590,7 @@ declare namespace gapi.client {
|
|
|
589
590
|
/** OAuth 2.0 token for the current user. */
|
|
590
591
|
oauth_token?:
|
|
591
592
|
string;
|
|
592
|
-
/** Required. The
|
|
593
|
+
/** Required. The name of the case to which the comment should be added. */
|
|
593
594
|
parent:
|
|
594
595
|
string;
|
|
595
596
|
/** Returns response with indentations and line breaks. */
|
|
@@ -630,7 +631,7 @@ declare namespace gapi.client {
|
|
|
630
631
|
/** OAuth 2.0 token for the current user. */
|
|
631
632
|
oauth_token?:
|
|
632
633
|
string;
|
|
633
|
-
/** Required. The
|
|
634
|
+
/** Required. The name of the case to which the comment should be added. */
|
|
634
635
|
parent:
|
|
635
636
|
string;
|
|
636
637
|
/** Returns response with indentations and line breaks. */
|
|
@@ -648,8 +649,10 @@ declare namespace gapi.client {
|
|
|
648
649
|
},
|
|
649
650
|
body: Comment): Request<Comment>;
|
|
650
651
|
/**
|
|
651
|
-
*
|
|
652
|
-
*
|
|
652
|
+
* List all the comments associated with a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --header "Authorization: Bearer $(gcloud auth
|
|
653
|
+
* print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService =
|
|
654
|
+
* googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", )
|
|
655
|
+
* request = ( supportApiService.cases() .comments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```
|
|
653
656
|
*/
|
|
654
657
|
list(request?: {
|
|
655
658
|
/** V1 error format. */
|
|
@@ -673,13 +676,13 @@ declare namespace gapi.client {
|
|
|
673
676
|
/** OAuth 2.0 token for the current user. */
|
|
674
677
|
oauth_token?:
|
|
675
678
|
string;
|
|
676
|
-
/** The maximum number of comments
|
|
679
|
+
/** The maximum number of comments to fetch. Defaults to 10. */
|
|
677
680
|
pageSize?:
|
|
678
681
|
number;
|
|
679
|
-
/** A token identifying the page of results to return. If unspecified, the first page is
|
|
682
|
+
/** A token identifying the page of results to return. If unspecified, the first page is returned. */
|
|
680
683
|
pageToken?:
|
|
681
684
|
string;
|
|
682
|
-
/** Required. The
|
|
685
|
+
/** Required. The name of the case for which to list comments. */
|
|
683
686
|
parent:
|
|
684
687
|
string;
|
|
685
688
|
/** Returns response with indentations and line breaks. */
|
|
@@ -1222,9 +1225,12 @@ declare namespace gapi.client {
|
|
|
1222
1225
|
}
|
|
1223
1226
|
interface MediaResource {
|
|
1224
1227
|
/**
|
|
1225
|
-
* Download a file
|
|
1228
|
+
* Download a file attached to a case. Note: HTTP requests must append "?alt=media" to the URL. EXAMPLES: cURL: ```shell
|
|
1226
1229
|
* name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \
|
|
1227
|
-
* "https://cloudsupport.googleapis.com/v2/$name:download?alt=media" ```
|
|
1230
|
+
* "https://cloudsupport.googleapis.com/v2/$name:download?alt=media" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService =
|
|
1231
|
+
* googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", )
|
|
1232
|
+
* request = supportApiService.media().download( name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" ) request.uri = request.uri.split("?")[0] + "?alt=media"
|
|
1233
|
+
* print(request.execute()) ```
|
|
1228
1234
|
*/
|
|
1229
1235
|
download(request?: {
|
|
1230
1236
|
/** V1 error format. */
|
|
@@ -1245,7 +1251,7 @@ declare namespace gapi.client {
|
|
|
1245
1251
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1246
1252
|
key?:
|
|
1247
1253
|
string;
|
|
1248
|
-
/** The
|
|
1254
|
+
/** The name of the file attachment to download. */
|
|
1249
1255
|
name:
|
|
1250
1256
|
string;
|
|
1251
1257
|
/** OAuth 2.0 token for the current user. */
|
|
@@ -1265,10 +1271,13 @@ declare namespace gapi.client {
|
|
|
1265
1271
|
string;
|
|
1266
1272
|
}): Request<Media>;
|
|
1267
1273
|
/**
|
|
1268
|
-
* Create a file attachment on a case or Cloud resource. The attachment
|
|
1269
|
-
*
|
|
1270
|
-
*
|
|
1271
|
-
* "
|
|
1274
|
+
* Create a file attachment on a case or Cloud resource. The attachment must have the following fields set: `filename`. EXAMPLES: cURL: ```shell echo "This text is in a file I'm
|
|
1275
|
+
* uploading using CSAPI." \ > "./example_file.txt" case="projects/some-project/cases/43594844" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \
|
|
1276
|
+
* --data-binary @"./example_file.txt" \ "https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.filename=uploaded_via_curl.txt" ``` Python: ```python import
|
|
1277
|
+
* googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version,
|
|
1278
|
+
* discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) file_path = "./example_file.txt" with open(file_path, "w") as file: file.write(
|
|
1279
|
+
* "This text is inside a file I'm going to upload using the Cloud Support API.", ) request = supportApiService.media().upload( parent="projects/some-project/cases/43595344",
|
|
1280
|
+
* media_body=file_path ) request.uri = request.uri.split("?")[0] + "?attachment.filename=uploaded_via_python.txt" print(request.execute()) ```
|
|
1272
1281
|
*/
|
|
1273
1282
|
upload(request: {
|
|
1274
1283
|
/** V1 error format. */
|
|
@@ -1292,7 +1301,7 @@ declare namespace gapi.client {
|
|
|
1292
1301
|
/** OAuth 2.0 token for the current user. */
|
|
1293
1302
|
oauth_token?:
|
|
1294
1303
|
string;
|
|
1295
|
-
/** Required. The
|
|
1304
|
+
/** Required. The name of the case or Cloud resource to which the attachment should be attached. */
|
|
1296
1305
|
parent:
|
|
1297
1306
|
string;
|
|
1298
1307
|
/** Returns response with indentations and line breaks. */
|
|
@@ -1333,7 +1342,7 @@ declare namespace gapi.client {
|
|
|
1333
1342
|
/** OAuth 2.0 token for the current user. */
|
|
1334
1343
|
oauth_token?:
|
|
1335
1344
|
string;
|
|
1336
|
-
/** Required. The
|
|
1345
|
+
/** Required. The name of the case or Cloud resource to which the attachment should be attached. */
|
|
1337
1346
|
parent:
|
|
1338
1347
|
string;
|
|
1339
1348
|
/** Returns response with indentations and line breaks. */
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -107,12 +107,12 @@ Search cases using the specified query. Here is an example of calling this endpo
|
|
|
107
107
|
await gapi.client.cloudsupport.cases.search({ parent: "parent", });
|
|
108
108
|
|
|
109
109
|
/*
|
|
110
|
-
Download a file
|
|
110
|
+
Download a file attached to a case. Note: HTTP requests must append "?alt=media" to the URL. EXAMPLES: 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" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.media().download( name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" ) request.uri = request.uri.split("?")[0] + "?alt=media" print(request.execute()) ```
|
|
111
111
|
*/
|
|
112
112
|
await gapi.client.cloudsupport.media.download({ name: "name", });
|
|
113
113
|
|
|
114
114
|
/*
|
|
115
|
-
Create a file attachment on a case or Cloud resource. The attachment
|
|
115
|
+
Create a file attachment on a case or Cloud resource. The attachment must have the following fields set: `filename`. EXAMPLES: 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" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) file_path = "./example_file.txt" with open(file_path, "w") as file: file.write( "This text is inside a file I'm going to upload using the Cloud Support API.", ) request = supportApiService.media().upload( parent="projects/some-project/cases/43595344", media_body=file_path ) request.uri = request.uri.split("?")[0] + "?attachment.filename=uploaded_via_python.txt" print(request.execute()) ```
|
|
116
116
|
*/
|
|
117
117
|
await gapi.client.cloudsupport.media.upload({ parent: "parent", });
|
|
118
118
|
```
|
package/tests.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
4
4
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
5
5
|
|
|
6
|
-
// Revision:
|
|
6
|
+
// Revision: 20230904
|
|
7
7
|
|
|
8
8
|
gapi.load('client', async () => {
|
|
9
9
|
/** now we can use gapi.client */
|
|
@@ -163,8 +163,10 @@ gapi.load('client', async () => {
|
|
|
163
163
|
query: "Test string",
|
|
164
164
|
});
|
|
165
165
|
/**
|
|
166
|
-
*
|
|
167
|
-
*
|
|
166
|
+
* List all the attachments associated with a support case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/23598314" curl \ --header "Authorization: Bearer $(gcloud auth
|
|
167
|
+
* print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/attachments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService =
|
|
168
|
+
* googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", )
|
|
169
|
+
* request = ( supportApiService.cases() .attachments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```
|
|
168
170
|
*/
|
|
169
171
|
await gapi.client.cloudsupport.cases.attachments.list({
|
|
170
172
|
pageSize: 42,
|
|
@@ -172,9 +174,11 @@ gapi.load('client', async () => {
|
|
|
172
174
|
parent: "Test string",
|
|
173
175
|
});
|
|
174
176
|
/**
|
|
175
|
-
* Add a new comment to
|
|
176
|
-
*
|
|
177
|
-
*
|
|
177
|
+
* Add a new comment to a case. The comment must have the following fields set: `body`. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43591344" curl \ --request POST \
|
|
178
|
+
* --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "body": "This is a test comment." }' \
|
|
179
|
+
* "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build(
|
|
180
|
+
* serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = (
|
|
181
|
+
* supportApiService.cases() .comments() .create( parent="projects/some-project/cases/43595344", body={"body": "This is a test comment."}, ) ) print(request.execute()) ```
|
|
178
182
|
*/
|
|
179
183
|
await gapi.client.cloudsupport.cases.comments.create({
|
|
180
184
|
parent: "Test string",
|
|
@@ -190,8 +194,10 @@ gapi.load('client', async () => {
|
|
|
190
194
|
plainTextBody: "Test string",
|
|
191
195
|
});
|
|
192
196
|
/**
|
|
193
|
-
*
|
|
194
|
-
*
|
|
197
|
+
* List all the comments associated with a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --header "Authorization: Bearer $(gcloud auth
|
|
198
|
+
* print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService =
|
|
199
|
+
* googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", )
|
|
200
|
+
* request = ( supportApiService.cases() .comments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```
|
|
195
201
|
*/
|
|
196
202
|
await gapi.client.cloudsupport.cases.comments.list({
|
|
197
203
|
pageSize: 42,
|
|
@@ -199,17 +205,24 @@ gapi.load('client', async () => {
|
|
|
199
205
|
parent: "Test string",
|
|
200
206
|
});
|
|
201
207
|
/**
|
|
202
|
-
* Download a file
|
|
208
|
+
* Download a file attached to a case. Note: HTTP requests must append "?alt=media" to the URL. EXAMPLES: cURL: ```shell
|
|
203
209
|
* name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \
|
|
204
|
-
* "https://cloudsupport.googleapis.com/v2/$name:download?alt=media" ```
|
|
210
|
+
* "https://cloudsupport.googleapis.com/v2/$name:download?alt=media" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService =
|
|
211
|
+
* googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", )
|
|
212
|
+
* request = supportApiService.media().download( name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" ) request.uri = request.uri.split("?")[0] + "?alt=media"
|
|
213
|
+
* print(request.execute()) ```
|
|
205
214
|
*/
|
|
206
215
|
await gapi.client.cloudsupport.media.download({
|
|
207
216
|
name: "Test string",
|
|
208
217
|
});
|
|
209
218
|
/**
|
|
210
|
-
* Create a file attachment on a case or Cloud resource. The attachment
|
|
211
|
-
*
|
|
212
|
-
*
|
|
219
|
+
* Create a file attachment on a case or Cloud resource. The attachment must have the following fields set: `filename`. EXAMPLES: cURL: ```shell echo "This text is in a file I'm uploading
|
|
220
|
+
* using CSAPI." \ > "./example_file.txt" case="projects/some-project/cases/43594844" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --data-binary
|
|
221
|
+
* @"./example_file.txt" \ "https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.filename=uploaded_via_curl.txt" ``` Python: ```python import
|
|
222
|
+
* googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version,
|
|
223
|
+
* discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) file_path = "./example_file.txt" with open(file_path, "w") as file: file.write( "This
|
|
224
|
+
* text is inside a file I'm going to upload using the Cloud Support API.", ) request = supportApiService.media().upload( parent="projects/some-project/cases/43595344",
|
|
225
|
+
* media_body=file_path ) request.uri = request.uri.split("?")[0] + "?attachment.filename=uploaded_via_python.txt" print(request.execute()) ```
|
|
213
226
|
*/
|
|
214
227
|
await gapi.client.cloudsupport.media.upload({
|
|
215
228
|
parent: "Test string",
|