@maxim_mazurok/gapi.client.cloudsupport-v2 0.0.20231128 → 0.0.20231203

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 CHANGED
@@ -9,1373 +9,888 @@
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: 20231128
12
+ // Revision: 20231203
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
16
16
  declare namespace gapi.client {
17
- /** Load Google Cloud Support API v2 */
18
- function load(urlOrObject: "https://cloudsupport.googleapis.com/$discovery/rest?version=v2"): Promise<void>;
19
- /** @deprecated Please load APIs with discovery documents. */
20
- function load(name: "cloudsupport", version: "v2"): Promise<void>;
21
- /** @deprecated Please load APIs with discovery documents. */
22
- function load(name: "cloudsupport", version: "v2", callback: () => any): void;
17
+ /** Load Google Cloud Support API v2 */
18
+ function load(
19
+ urlOrObject: 'https://cloudsupport.googleapis.com/$discovery/rest?version=v2'
20
+ ): Promise<void>;
21
+ /** @deprecated Please load APIs with discovery documents. */
22
+ function load(name: 'cloudsupport', version: 'v2'): Promise<void>;
23
+ /** @deprecated Please load APIs with discovery documents. */
24
+ function load(name: 'cloudsupport', version: 'v2', callback: () => any): void;
23
25
 
24
- namespace cloudsupport {
25
- interface Actor {
26
- /**
27
- * 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.
28
- * This will be obfuscated if the user is a Google Support agent.
29
- */
30
- displayName?:
31
- string;
32
- /**
33
- * 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
34
- * 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.
35
- */
36
- email?:
37
- string;
38
- /** Output only. Whether the actor is a Google support actor. */
39
- googleSupport?:
40
- boolean;
41
- }
42
- interface Attachment {
43
- /** Output only. The time at which the attachment was created. */
44
- createTime?:
45
- string;
46
- /** Output only. The user who uploaded the attachment. Note, the name and email will be obfuscated if the attachment was uploaded by Google support. */
47
- creator?:
48
- Actor;
49
- /** The filename of the attachment (e.g. `"graph.jpg"`). */
50
- filename?:
51
- string;
52
- /** Output only. The MIME type of the attachment (e.g. text/plain). */
53
- mimeType?:
54
- string;
55
- /** Output only. The resource name of the attachment. */
56
- name?:
57
- string;
58
- /** Output only. The size of the attachment in bytes. */
59
- sizeBytes?:
60
- string;
61
- }
62
- interface Blobstore2Info {
63
- /** # gdata.* are outside protos with mising documentation */
64
- blobGeneration?:
65
- string;
66
- /** # gdata.* are outside protos with mising documentation */
67
- blobId?:
68
- string;
69
- /** # gdata.* are outside protos with mising documentation */
70
- downloadReadHandle?:
71
- string;
72
- /** # gdata.* are outside protos with mising documentation */
73
- readToken?:
74
- string;
75
- /** # gdata.* are outside protos with mising documentation */
76
- uploadMetadataContainer?:
77
- string;
78
- }
79
- interface Case {
80
- /** The issue classification applicable to this case. */
81
- classification?:
82
- CaseClassification;
83
- /**
84
- * A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their
85
- * EUCs.
86
- */
87
- contactEmail?:
88
- string;
89
- /** Output only. The time this case was created. */
90
- createTime?:
91
- string;
92
- /** The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support. */
93
- creator?:
94
- Actor;
95
- /** A broad description of the issue. */
96
- description?:
97
- string;
98
- /** The short summary of the issue reported in this case. */
99
- displayName?:
100
- string;
101
- /** Whether the case is currently escalated. */
102
- escalated?:
103
- boolean;
104
- /**
105
- * The language the user has requested to receive support in. This should be a BCP 47 language code (e.g., `"en"`, `"zh-CN"`, `"zh-TW"`, `"ja"`, `"ko"`). If no language or an
106
- * unsupported language is specified, this field defaults to English (en). Language selection during case creation may affect your available support options. For a list of supported
107
- * languages and their support working hours, see: https://cloud.google.com/support/docs/language-working-hours
108
- */
109
- languageCode?:
110
- string;
111
- /** The resource name for the case. */
112
- name?:
113
- string;
114
- /** The priority of this case. */
115
- priority?:
116
- string;
117
- /** Output only. The current status of the support case. */
118
- state?:
119
- string;
120
- /** The email addresses to receive updates on this case. */
121
- subscriberEmailAddresses?:
122
- string[];
123
- /** Whether this case was created for internal API testing and should not be acted on by the support team. */
124
- testCase?:
125
- boolean;
126
- /** The timezone of the user who created the support case. It should be in a format IANA recognizes: https://www.iana.org/time-zones. There is no additional validation done by the API. */
127
- timeZone?:
128
- string;
129
- /** Output only. The time this case was last updated. */
130
- updateTime?:
131
- string;
132
- }
133
- interface CaseClassification {
134
- /** 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. */
135
- displayName?:
136
- string;
137
- /**
138
- * 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
139
- * 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
140
- * 6 months, `case.create` requests using the classification ID will fail.
141
- */
142
- id?:
143
- string;
144
- }
145
- // tslint:disable-next-line:no-empty-interface
146
- interface CloseCaseRequest {
147
- }
148
- interface Comment {
149
- /** The full comment body. Maximum of 12800 characters. This can contain rich text syntax. */
150
- body?:
151
- string;
152
- /** Output only. The time when this comment was created. */
153
- createTime?:
154
- string;
155
- /** Output only. The user or Google Support agent created this comment. */
156
- creator?:
157
- Actor;
158
- /** Output only. The resource name for the comment. */
159
- name?:
160
- string;
161
- /** Output only. DEPRECATED. An automatically generated plain text version of body with all rich text syntax stripped. */
162
- plainTextBody?:
163
- string;
164
- }
165
- interface CompositeMedia {
166
- /** # gdata.* are outside protos with mising documentation */
167
- blobRef?:
168
- string;
169
- /** # gdata.* are outside protos with mising documentation */
170
- blobstore2Info?:
171
- Blobstore2Info;
172
- /** # gdata.* are outside protos with mising documentation */
173
- cosmoBinaryReference?:
174
- string;
175
- /** # gdata.* are outside protos with mising documentation */
176
- crc32cHash?:
177
- number;
178
- /** # gdata.* are outside protos with mising documentation */
179
- inline?:
180
- string;
181
- /** # gdata.* are outside protos with mising documentation */
182
- length?:
183
- string;
184
- /** # gdata.* are outside protos with mising documentation */
185
- md5Hash?:
186
- string;
187
- /** # gdata.* are outside protos with mising documentation */
188
- objectId?:
189
- ObjectId;
190
- /** # gdata.* are outside protos with mising documentation */
191
- path?:
192
- string;
193
- /** # gdata.* are outside protos with mising documentation */
194
- referenceType?:
195
- string;
196
- /** # gdata.* are outside protos with mising documentation */
197
- sha1Hash?:
198
- string;
199
- }
200
- interface ContentTypeInfo {
201
- /** # gdata.* are outside protos with mising documentation */
202
- bestGuess?:
203
- string;
204
- /** # gdata.* are outside protos with mising documentation */
205
- fromBytes?:
206
- string;
207
- /** # gdata.* are outside protos with mising documentation */
208
- fromFileName?:
209
- string;
210
- /** # gdata.* are outside protos with mising documentation */
211
- fromHeader?:
212
- string;
213
- /** # gdata.* are outside protos with mising documentation */
214
- fromUrlPath?:
215
- string;
216
- }
217
- interface CreateAttachmentRequest {
218
- /** Required. The attachment to be created. */
219
- attachment?:
220
- Attachment;
221
- }
222
- interface DiffChecksumsResponse {
223
- /** # gdata.* are outside protos with mising documentation */
224
- checksumsLocation?:
225
- CompositeMedia;
226
- /** # gdata.* are outside protos with mising documentation */
227
- chunkSizeBytes?:
228
- string;
229
- /** # gdata.* are outside protos with mising documentation */
230
- objectLocation?:
231
- CompositeMedia;
232
- /** # gdata.* are outside protos with mising documentation */
233
- objectSizeBytes?:
234
- string;
235
- /** # gdata.* are outside protos with mising documentation */
236
- objectVersion?:
237
- string;
238
- }
239
- interface DiffDownloadResponse {
240
- /** # gdata.* are outside protos with mising documentation */
241
- objectLocation?:
242
- CompositeMedia;
243
- }
244
- interface DiffUploadRequest {
245
- /** # gdata.* are outside protos with mising documentation */
246
- checksumsInfo?:
247
- CompositeMedia;
248
- /** # gdata.* are outside protos with mising documentation */
249
- objectInfo?:
250
- CompositeMedia;
251
- /** # gdata.* are outside protos with mising documentation */
252
- objectVersion?:
253
- string;
254
- }
255
- interface DiffUploadResponse {
256
- /** # gdata.* are outside protos with mising documentation */
257
- objectVersion?:
258
- string;
259
- /** # gdata.* are outside protos with mising documentation */
260
- originalObject?:
261
- CompositeMedia;
262
- }
263
- interface DiffVersionResponse {
264
- /** # gdata.* are outside protos with mising documentation */
265
- objectSizeBytes?:
266
- string;
267
- /** # gdata.* are outside protos with mising documentation */
268
- objectVersion?:
269
- string;
270
- }
271
- interface DownloadParameters {
272
- /** # gdata.* are outside protos with mising documentation */
273
- allowGzipCompression?:
274
- boolean;
275
- /** # gdata.* are outside protos with mising documentation */
276
- ignoreRange?:
277
- boolean;
278
- }
279
- interface EscalateCaseRequest {
280
- /** The escalation information to be sent with the escalation request. */
281
- escalation?:
282
- Escalation;
283
- }
284
- interface Escalation {
285
- /** Required. A free text description to accompany the `reason` field above. Provides additional context on why the case is being escalated. */
286
- justification?:
287
- string;
288
- /** Required. The reason why the Case is being escalated. */
289
- reason?:
290
- string;
291
- }
292
- interface ListAttachmentsResponse {
293
- /** The list of attachments associated with a case. */
294
- attachments?:
295
- Attachment[];
296
- /**
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
- */
300
- nextPageToken?:
301
- string;
302
- }
303
- interface ListCasesResponse {
304
- /** The list of cases associated with the parent after any filters have been applied. */
305
- cases?:
306
- Case[];
307
- /** 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. */
308
- nextPageToken?:
309
- string;
310
- }
311
- interface ListCommentsResponse {
312
- /** List of the comments associated with the case. */
313
- comments?:
314
- Comment[];
315
- /** 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. */
316
- nextPageToken?:
317
- string;
318
- }
319
- interface Media {
320
- /** # gdata.* are outside protos with mising documentation */
321
- algorithm?:
322
- string;
323
- /** # gdata.* are outside protos with mising documentation */
324
- bigstoreObjectRef?:
325
- string;
326
- /** # gdata.* are outside protos with mising documentation */
327
- blobRef?:
328
- string;
329
- /** # gdata.* are outside protos with mising documentation */
330
- blobstore2Info?:
331
- Blobstore2Info;
332
- /** # gdata.* are outside protos with mising documentation */
333
- compositeMedia?:
334
- CompositeMedia[];
335
- /** # gdata.* are outside protos with mising documentation */
336
- contentType?:
337
- string;
338
- /** # gdata.* are outside protos with mising documentation */
339
- contentTypeInfo?:
340
- ContentTypeInfo;
341
- /** # gdata.* are outside protos with mising documentation */
342
- cosmoBinaryReference?:
343
- string;
344
- /** # gdata.* are outside protos with mising documentation */
345
- crc32cHash?:
346
- number;
347
- /** # gdata.* are outside protos with mising documentation */
348
- diffChecksumsResponse?:
349
- DiffChecksumsResponse;
350
- /** # gdata.* are outside protos with mising documentation */
351
- diffDownloadResponse?:
352
- DiffDownloadResponse;
353
- /** # gdata.* are outside protos with mising documentation */
354
- diffUploadRequest?:
355
- DiffUploadRequest;
356
- /** # gdata.* are outside protos with mising documentation */
357
- diffUploadResponse?:
358
- DiffUploadResponse;
359
- /** # gdata.* are outside protos with mising documentation */
360
- diffVersionResponse?:
361
- DiffVersionResponse;
362
- /** # gdata.* are outside protos with mising documentation */
363
- downloadParameters?:
364
- DownloadParameters;
365
- /** # gdata.* are outside protos with mising documentation */
366
- filename?:
367
- string;
368
- /** # gdata.* are outside protos with mising documentation */
369
- hash?:
370
- string;
371
- /** # gdata.* are outside protos with mising documentation */
372
- hashVerified?:
373
- boolean;
374
- /** # gdata.* are outside protos with mising documentation */
375
- inline?:
376
- string;
377
- /** # gdata.* are outside protos with mising documentation */
378
- isPotentialRetry?:
379
- boolean;
380
- /** # gdata.* are outside protos with mising documentation */
381
- length?:
382
- string;
383
- /** # gdata.* are outside protos with mising documentation */
384
- md5Hash?:
385
- string;
386
- /** # gdata.* are outside protos with mising documentation */
387
- mediaId?:
388
- string;
389
- /** # gdata.* are outside protos with mising documentation */
390
- objectId?:
391
- ObjectId;
392
- /** # gdata.* are outside protos with mising documentation */
393
- path?:
394
- string;
395
- /** # gdata.* are outside protos with mising documentation */
396
- referenceType?:
397
- string;
398
- /** # gdata.* are outside protos with mising documentation */
399
- sha1Hash?:
400
- string;
401
- /** # gdata.* are outside protos with mising documentation */
402
- sha256Hash?:
403
- string;
404
- /** # gdata.* are outside protos with mising documentation */
405
- timestamp?:
406
- string;
407
- /** # gdata.* are outside protos with mising documentation */
408
- token?:
409
- string;
410
- }
411
- interface ObjectId {
412
- /** # gdata.* are outside protos with mising documentation */
413
- bucketName?:
414
- string;
415
- /** # gdata.* are outside protos with mising documentation */
416
- generation?:
417
- string;
418
- /** # gdata.* are outside protos with mising documentation */
419
- objectName?:
420
- string;
421
- }
422
- interface SearchCaseClassificationsResponse {
423
- /** The classifications retrieved. */
424
- caseClassifications?:
425
- CaseClassification[];
426
- /**
427
- * 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
428
- * retrieve.
429
- */
430
- nextPageToken?:
431
- string;
432
- }
433
- interface SearchCasesResponse {
434
- /** The list of cases associated with the parent after any filters have been applied. */
435
- cases?:
436
- Case[];
437
- /** 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. */
438
- nextPageToken?:
439
- string;
440
- }
441
- interface WorkflowOperationMetadata {
442
- /** The namespace that the job was scheduled in. Must be included in the workflow metadata so the workflow status can be retrieved. */
443
- namespace?:
444
- string;
445
- /** The type of action the operation is classified as. */
446
- operationAction?:
447
- string;
448
- /** Which version of the workflow service this operation came from. */
449
- workflowOperationType?:
450
- string;
451
- }
452
- interface CaseClassificationsResource {
453
- /**
454
- * Retrieve valid classifications to use when creating a support case. Classifications are hierarchical. Each classification is a string containing all levels of the hierarchy
455
- * separated by `" > "`. For example, `"Technical Issue > Compute > Compute Engine"`. Classification IDs returned by this endpoint are valid for at least six months. When a
456
- * classification is deactivated, this endpoint immediately stops returning it. After six months, `case.create` requests using the classification will fail. EXAMPLES: cURL: ```shell
457
- * curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \
458
- * 'https://cloudsupport.googleapis.com/v2/caseClassifications:search?query=display_name:"*Compute%20Engine*"' ``` Python: ```python import googleapiclient.discovery supportApiService
459
- * = googleapiclient.discovery.build( serviceName="cloudsupport", version="v2", discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=v2", ) request =
460
- * supportApiService.caseClassifications().search( query='display_name:"*Compute Engine*"' ) print(request.execute()) ```
461
- */
462
- search(request?: {
463
- /** V1 error format. */
464
- "$.xgafv"?:
465
- string;
466
- /** OAuth access token. */
467
- access_token?:
468
- string;
469
- /** Data format for response. */
470
- alt?:
471
- string;
472
- /** JSONP */
473
- callback?:
474
- string;
475
- /** Selector specifying which fields to include in a partial response. */
476
- fields?:
477
- string;
478
- /** 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. */
479
- key?:
480
- string;
481
- /** OAuth 2.0 token for the current user. */
482
- oauth_token?:
483
- string;
484
- /** The maximum number of classifications fetched with each request. */
485
- pageSize?:
486
- number;
487
- /** A token identifying the page of results to return. If unspecified, the first page is retrieved. */
488
- pageToken?:
489
- string;
490
- /** Returns response with indentations and line breaks. */
491
- prettyPrint?:
492
- boolean;
493
- /** 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. */
494
- query?:
495
- string;
496
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
497
- quotaUser?:
498
- string;
499
- /** Upload protocol for media (e.g. "raw", "multipart"). */
500
- upload_protocol?:
501
- string;
502
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
503
- uploadType?:
504
- string;
505
- }): Request<SearchCaseClassificationsResponse>;
506
- }
507
- interface AttachmentsResource {
508
- /**
509
- * List all the attachments associated with a support case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/23598314" curl \ --header "Authorization: Bearer $(gcloud auth
510
- * print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/attachments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService =
511
- * googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", )
512
- * request = ( supportApiService.cases() .attachments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```
513
- */
514
- list(request?: {
515
- /** V1 error format. */
516
- "$.xgafv"?:
517
- string;
518
- /** OAuth access token. */
519
- access_token?:
520
- string;
521
- /** Data format for response. */
522
- alt?:
523
- string;
524
- /** JSONP */
525
- callback?:
526
- string;
527
- /** Selector specifying which fields to include in a partial response. */
528
- fields?:
529
- string;
530
- /** 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. */
531
- key?:
532
- string;
533
- /** OAuth 2.0 token for the current user. */
534
- oauth_token?:
535
- string;
536
- /** The maximum number of attachments fetched with each request. If not provided, the default is 10. The maximum page size that will be returned is 100. */
537
- pageSize?:
538
- number;
539
- /** A token identifying the page of results to return. If unspecified, the first page is retrieved. */
540
- pageToken?:
541
- string;
542
- /** Required. The name of the case for which attachments should be listed. */
543
- parent:
544
- string;
545
- /** Returns response with indentations and line breaks. */
546
- prettyPrint?:
547
- boolean;
548
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
549
- quotaUser?:
550
- string;
551
- /** Upload protocol for media (e.g. "raw", "multipart"). */
552
- upload_protocol?:
553
- string;
554
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
555
- uploadType?:
556
- string;
557
- }): Request<ListAttachmentsResponse>;
558
- }
559
- interface CommentsResource {
560
- /**
561
- * 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 \
562
- * --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "body": "This is a test comment." }' \
563
- * "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService =
564
- * googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", )
565
- * request = ( supportApiService.cases() .comments() .create( parent="projects/some-project/cases/43595344", body={"body": "This is a test comment."}, ) ) print(request.execute()) ```
566
- */
567
- create(request: {
568
- /** V1 error format. */
569
- "$.xgafv"?:
570
- string;
571
- /** OAuth access token. */
572
- access_token?:
573
- string;
574
- /** Data format for response. */
575
- alt?:
576
- string;
577
- /** JSONP */
578
- callback?:
579
- string;
580
- /** Selector specifying which fields to include in a partial response. */
581
- fields?:
582
- string;
583
- /** 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. */
584
- key?:
585
- string;
586
- /** OAuth 2.0 token for the current user. */
587
- oauth_token?:
588
- string;
589
- /** Required. The name of the case to which the comment should be added. */
590
- parent:
591
- string;
592
- /** Returns response with indentations and line breaks. */
593
- prettyPrint?:
594
- boolean;
595
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
596
- quotaUser?:
597
- string;
598
- /** Upload protocol for media (e.g. "raw", "multipart"). */
599
- upload_protocol?:
600
- string;
601
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
602
- uploadType?:
603
- string;
604
- /** Request body */
605
- resource:
606
- Comment;
607
- }): Request<Comment>;
608
- create(request: {
609
- /** V1 error format. */
610
- "$.xgafv"?:
611
- string;
612
- /** OAuth access token. */
613
- access_token?:
614
- string;
615
- /** Data format for response. */
616
- alt?:
617
- string;
618
- /** JSONP */
619
- callback?:
620
- string;
621
- /** Selector specifying which fields to include in a partial response. */
622
- fields?:
623
- string;
624
- /** 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. */
625
- key?:
626
- string;
627
- /** OAuth 2.0 token for the current user. */
628
- oauth_token?:
629
- string;
630
- /** Required. The name of the case to which the comment should be added. */
631
- parent:
632
- string;
633
- /** Returns response with indentations and line breaks. */
634
- prettyPrint?:
635
- boolean;
636
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
637
- quotaUser?:
638
- string;
639
- /** Upload protocol for media (e.g. "raw", "multipart"). */
640
- upload_protocol?:
641
- string;
642
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
643
- uploadType?:
644
- string;
645
- },
646
- body: Comment): Request<Comment>;
647
- /**
648
- * List all the comments associated with a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --header "Authorization: Bearer $(gcloud auth
649
- * print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService =
650
- * googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", )
651
- * request = ( supportApiService.cases() .comments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```
652
- */
653
- list(request?: {
654
- /** V1 error format. */
655
- "$.xgafv"?:
656
- string;
657
- /** OAuth access token. */
658
- access_token?:
659
- string;
660
- /** Data format for response. */
661
- alt?:
662
- string;
663
- /** JSONP */
664
- callback?:
665
- string;
666
- /** Selector specifying which fields to include in a partial response. */
667
- fields?:
668
- string;
669
- /** 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. */
670
- key?:
671
- string;
672
- /** OAuth 2.0 token for the current user. */
673
- oauth_token?:
674
- string;
675
- /** The maximum number of comments to fetch. Defaults to 10. */
676
- pageSize?:
677
- number;
678
- /** A token identifying the page of results to return. If unspecified, the first page is returned. */
679
- pageToken?:
680
- string;
681
- /** Required. The name of the case for which to list comments. */
682
- parent:
683
- string;
684
- /** Returns response with indentations and line breaks. */
685
- prettyPrint?:
686
- boolean;
687
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
688
- quotaUser?:
689
- string;
690
- /** Upload protocol for media (e.g. "raw", "multipart"). */
691
- upload_protocol?:
692
- string;
693
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
694
- uploadType?:
695
- string;
696
- }): Request<ListCommentsResponse>;
697
- }
698
- interface CasesResource {
699
- /**
700
- * Close a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \
701
- * "https://cloudsupport.googleapis.com/v2/$case:close" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build(
702
- * serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request =
703
- * supportApiService.cases().close( name="projects/some-project/cases/43595344" ) print(request.execute()) ```
704
- */
705
- close(request: {
706
- /** V1 error format. */
707
- "$.xgafv"?:
708
- string;
709
- /** OAuth access token. */
710
- access_token?:
711
- string;
712
- /** Data format for response. */
713
- alt?:
714
- string;
715
- /** JSONP */
716
- callback?:
717
- string;
718
- /** Selector specifying which fields to include in a partial response. */
719
- fields?:
720
- string;
721
- /** 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. */
722
- key?:
723
- string;
724
- /** Required. The name of the case to close. */
725
- name:
726
- string;
727
- /** OAuth 2.0 token for the current user. */
728
- oauth_token?:
729
- string;
730
- /** Returns response with indentations and line breaks. */
731
- prettyPrint?:
732
- boolean;
733
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
734
- quotaUser?:
735
- string;
736
- /** Upload protocol for media (e.g. "raw", "multipart"). */
737
- upload_protocol?:
738
- string;
739
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
740
- uploadType?:
741
- string;
742
- /** Request body */
743
- resource:
744
- CloseCaseRequest;
745
- }): Request<Case>;
746
- close(request: {
747
- /** V1 error format. */
748
- "$.xgafv"?:
749
- string;
750
- /** OAuth access token. */
751
- access_token?:
752
- string;
753
- /** Data format for response. */
754
- alt?:
755
- string;
756
- /** JSONP */
757
- callback?:
758
- string;
759
- /** Selector specifying which fields to include in a partial response. */
760
- fields?:
761
- string;
762
- /** 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. */
763
- key?:
764
- string;
765
- /** Required. The name of the case to close. */
766
- name:
767
- string;
768
- /** OAuth 2.0 token for the current user. */
769
- oauth_token?:
770
- string;
771
- /** Returns response with indentations and line breaks. */
772
- prettyPrint?:
773
- boolean;
774
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
775
- quotaUser?:
776
- string;
777
- /** Upload protocol for media (e.g. "raw", "multipart"). */
778
- upload_protocol?:
779
- string;
780
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
781
- uploadType?:
782
- string;
783
- },
784
- body: CloseCaseRequest): Request<Case>;
785
- /**
786
- * Create a new case and associate it with a parent. It must have the following fields set: `display_name`, `description`, `classification`, and `priority`. If you're just testing the
787
- * API and don't want to route your case to an agent, set `testCase=true`. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --request POST \ --header "Authorization:
788
- * Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "display_name": "Test case created by me.", "description": "a random test case,
789
- * feel free to close", "classification": { "id": "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" },
790
- * "time_zone": "-07:00", "subscriber_email_addresses": [ "foo@domain.com", "bar@domain.com" ], "testCase": true, "priority": "P3" }' \
791
- * "https://cloudsupport.googleapis.com/v2/$parent/cases" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build(
792
- * serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request =
793
- * supportApiService.cases().create( parent="projects/some-project", body={ "displayName": "A Test Case", "description": "This is a test case.", "testCase": True, "priority": "P2",
794
- * "classification": { "id": "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" }, }, ) print(request.execute())
795
- * ```
796
- */
797
- create(request: {
798
- /** V1 error format. */
799
- "$.xgafv"?:
800
- string;
801
- /** OAuth access token. */
802
- access_token?:
803
- string;
804
- /** Data format for response. */
805
- alt?:
806
- string;
807
- /** JSONP */
808
- callback?:
809
- string;
810
- /** Selector specifying which fields to include in a partial response. */
811
- fields?:
812
- string;
813
- /** 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. */
814
- key?:
815
- string;
816
- /** OAuth 2.0 token for the current user. */
817
- oauth_token?:
818
- string;
819
- /** Required. The name of the parent under which the case should be created. */
820
- parent:
821
- string;
822
- /** Returns response with indentations and line breaks. */
823
- prettyPrint?:
824
- boolean;
825
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
826
- quotaUser?:
827
- string;
828
- /** Upload protocol for media (e.g. "raw", "multipart"). */
829
- upload_protocol?:
830
- string;
831
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
832
- uploadType?:
833
- string;
834
- /** Request body */
835
- resource:
836
- Case;
837
- }): Request<Case>;
838
- create(request: {
839
- /** V1 error format. */
840
- "$.xgafv"?:
841
- string;
842
- /** OAuth access token. */
843
- access_token?:
844
- string;
845
- /** Data format for response. */
846
- alt?:
847
- string;
848
- /** JSONP */
849
- callback?:
850
- string;
851
- /** Selector specifying which fields to include in a partial response. */
852
- fields?:
853
- string;
854
- /** 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. */
855
- key?:
856
- string;
857
- /** OAuth 2.0 token for the current user. */
858
- oauth_token?:
859
- string;
860
- /** Required. The name of the parent under which the case should be created. */
861
- parent:
862
- string;
863
- /** Returns response with indentations and line breaks. */
864
- prettyPrint?:
865
- boolean;
866
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
867
- quotaUser?:
868
- string;
869
- /** Upload protocol for media (e.g. "raw", "multipart"). */
870
- upload_protocol?:
871
- string;
872
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
873
- uploadType?:
874
- string;
875
- },
876
- body: Case): Request<Case>;
877
- /**
878
- * Escalate a case, starting the Google Cloud Support escalation management process. This operation is only available for some support services. Go to https://cloud.google.com/support
879
- * and look for 'Technical support escalations' in the feature list to find out which ones let you do that. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \
880
- * --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "escalation": { "reason":
881
- * "BUSINESS_IMPACT", "justification": "This is a test escalation." } }' \ "https://cloudsupport.googleapis.com/v2/$case:escalate" ``` Python: ```python import
882
- * googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version,
883
- * discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().escalate(
884
- * name="projects/some-project/cases/43595344", body={ "escalation": { "reason": "BUSINESS_IMPACT", "justification": "This is a test escalation.", }, }, ) print(request.execute()) ```
885
- */
886
- escalate(request: {
887
- /** V1 error format. */
888
- "$.xgafv"?:
889
- string;
890
- /** OAuth access token. */
891
- access_token?:
892
- string;
893
- /** Data format for response. */
894
- alt?:
895
- string;
896
- /** JSONP */
897
- callback?:
898
- string;
899
- /** Selector specifying which fields to include in a partial response. */
900
- fields?:
901
- string;
902
- /** 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. */
903
- key?:
904
- string;
905
- /** Required. The name of the case to be escalated. */
906
- name:
907
- string;
908
- /** OAuth 2.0 token for the current user. */
909
- oauth_token?:
910
- string;
911
- /** Returns response with indentations and line breaks. */
912
- prettyPrint?:
913
- boolean;
914
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
915
- quotaUser?:
916
- string;
917
- /** Upload protocol for media (e.g. "raw", "multipart"). */
918
- upload_protocol?:
919
- string;
920
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
921
- uploadType?:
922
- string;
923
- /** Request body */
924
- resource:
925
- EscalateCaseRequest;
926
- }): Request<Case>;
927
- escalate(request: {
928
- /** V1 error format. */
929
- "$.xgafv"?:
930
- string;
931
- /** OAuth access token. */
932
- access_token?:
933
- string;
934
- /** Data format for response. */
935
- alt?:
936
- string;
937
- /** JSONP */
938
- callback?:
939
- string;
940
- /** Selector specifying which fields to include in a partial response. */
941
- fields?:
942
- string;
943
- /** 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. */
944
- key?:
945
- string;
946
- /** Required. The name of the case to be escalated. */
947
- name:
948
- string;
949
- /** OAuth 2.0 token for the current user. */
950
- oauth_token?:
951
- string;
952
- /** Returns response with indentations and line breaks. */
953
- prettyPrint?:
954
- boolean;
955
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
956
- quotaUser?:
957
- string;
958
- /** Upload protocol for media (e.g. "raw", "multipart"). */
959
- upload_protocol?:
960
- string;
961
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
962
- uploadType?:
963
- string;
964
- },
965
- body: EscalateCaseRequest): Request<Case>;
966
- /**
967
- * Retrieve a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/16033687" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \
968
- * "https://cloudsupport.googleapis.com/v2/$case" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build(
969
- * serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request =
970
- * supportApiService.cases().get( name="projects/some-project/cases/43595344", ) print(request.execute()) ```
971
- */
972
- get(request?: {
973
- /** V1 error format. */
974
- "$.xgafv"?:
975
- string;
976
- /** OAuth access token. */
977
- access_token?:
978
- string;
979
- /** Data format for response. */
980
- alt?:
981
- string;
982
- /** JSONP */
983
- callback?:
984
- string;
985
- /** Selector specifying which fields to include in a partial response. */
986
- fields?:
987
- string;
988
- /** 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. */
989
- key?:
990
- string;
991
- /** Required. The full name of a case to be retrieved. */
992
- name:
993
- string;
994
- /** OAuth 2.0 token for the current user. */
995
- oauth_token?:
996
- string;
997
- /** Returns response with indentations and line breaks. */
998
- prettyPrint?:
999
- boolean;
1000
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1001
- quotaUser?:
1002
- string;
1003
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1004
- upload_protocol?:
1005
- string;
1006
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1007
- uploadType?:
1008
- string;
1009
- }): Request<Case>;
1010
- /**
1011
- * Retrieve all cases under a parent, but not its children. For example, listing cases under an organization only returns the cases that are directly parented by that organization. To
1012
- * retrieve cases under an organization and its projects, use `cases.search`. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --header "Authorization: Bearer $(gcloud
1013
- * auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$parent/cases" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService =
1014
- * googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", )
1015
- * request = supportApiService.cases().list(parent="projects/some-project") print(request.execute()) ```
1016
- */
1017
- list(request?: {
1018
- /** V1 error format. */
1019
- "$.xgafv"?:
1020
- string;
1021
- /** OAuth access token. */
1022
- access_token?:
1023
- string;
1024
- /** Data format for response. */
1025
- alt?:
1026
- string;
1027
- /** JSONP */
1028
- callback?:
1029
- string;
1030
- /** Selector specifying which fields to include in a partial response. */
1031
- fields?:
1032
- string;
1033
- /**
1034
- * An expression used to filter cases. If it's an empty string, then no filtering happens. Otherwise, the endpoint returns the cases that match the filter. Expressions use the
1035
- * 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
1036
- * values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - `creator.email`: The email address of the case creator. EXAMPLES: - `state=CLOSED` -
1037
- * `state=OPEN AND creator.email="tester@example.com"` - `state=OPEN AND (priority=P0 OR priority=P1)`
1038
- */
1039
- filter?:
1040
- string;
1041
- /** 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. */
1042
- key?:
1043
- string;
1044
- /** OAuth 2.0 token for the current user. */
1045
- oauth_token?:
1046
- string;
1047
- /** The maximum number of cases fetched with each request. Defaults to 10. */
1048
- pageSize?:
1049
- number;
1050
- /** A token identifying the page of results to return. If unspecified, the first page is retrieved. */
1051
- pageToken?:
1052
- string;
1053
- /** Required. The name of a parent to list cases under. */
1054
- parent:
1055
- string;
1056
- /** Returns response with indentations and line breaks. */
1057
- prettyPrint?:
1058
- boolean;
1059
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1060
- quotaUser?:
1061
- string;
1062
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1063
- upload_protocol?:
1064
- string;
1065
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1066
- uploadType?:
1067
- string;
1068
- }): Request<ListCasesResponse>;
1069
- /**
1070
- * Update a case. Only some fields can be updated. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request PATCH \ --header "Authorization: Bearer
1071
- * $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "priority": "P1" }' \ "https://cloudsupport.googleapis.com/v2/$case?updateMask=priority"
1072
- * ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version,
1073
- * discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().patch(
1074
- * name="projects/some-project/cases/43112854", body={ "displayName": "This is Now a New Title", "priority": "P2", }, ) print(request.execute()) ```
1075
- */
1076
- patch(request: {
1077
- /** V1 error format. */
1078
- "$.xgafv"?:
1079
- string;
1080
- /** OAuth access token. */
1081
- access_token?:
1082
- string;
1083
- /** Data format for response. */
1084
- alt?:
1085
- string;
1086
- /** JSONP */
1087
- callback?:
1088
- string;
1089
- /** Selector specifying which fields to include in a partial response. */
1090
- fields?:
1091
- string;
1092
- /** 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. */
1093
- key?:
1094
- string;
1095
- /** The resource name for the case. */
1096
- name:
1097
- string;
1098
- /** OAuth 2.0 token for the current user. */
1099
- oauth_token?:
1100
- string;
1101
- /** Returns response with indentations and line breaks. */
1102
- prettyPrint?:
1103
- boolean;
1104
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1105
- quotaUser?:
1106
- string;
1107
- /**
1108
- * 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
1109
- * supported fields are updated. 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
1110
- * do not provide a value for `subscriber_email_addresses`, then `subscriber_email_addresses` is updated to empty.
1111
- */
1112
- updateMask?:
1113
- string;
1114
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1115
- upload_protocol?:
1116
- string;
1117
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1118
- uploadType?:
1119
- string;
1120
- /** Request body */
1121
- resource:
1122
- Case;
1123
- }): Request<Case>;
1124
- patch(request: {
1125
- /** V1 error format. */
1126
- "$.xgafv"?:
1127
- string;
1128
- /** OAuth access token. */
1129
- access_token?:
1130
- string;
1131
- /** Data format for response. */
1132
- alt?:
1133
- string;
1134
- /** JSONP */
1135
- callback?:
1136
- string;
1137
- /** Selector specifying which fields to include in a partial response. */
1138
- fields?:
1139
- string;
1140
- /** 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. */
1141
- key?:
1142
- string;
1143
- /** The resource name for the case. */
1144
- name:
1145
- string;
1146
- /** OAuth 2.0 token for the current user. */
1147
- oauth_token?:
1148
- string;
1149
- /** Returns response with indentations and line breaks. */
1150
- prettyPrint?:
1151
- boolean;
1152
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1153
- quotaUser?:
1154
- string;
1155
- /**
1156
- * 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
1157
- * supported fields are updated. 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
1158
- * do not provide a value for `subscriber_email_addresses`, then `subscriber_email_addresses` is updated to empty.
1159
- */
1160
- updateMask?:
1161
- string;
1162
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1163
- upload_protocol?:
1164
- string;
1165
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1166
- uploadType?:
1167
- string;
1168
- },
1169
- body: Case): Request<Case>;
1170
- /**
1171
- * Search for cases using a query. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \
1172
- * "https://cloudsupport.googleapis.com/v2/$parent/cases:search" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService =
1173
- * googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", )
1174
- * request = supportApiService.cases().search( parent="projects/some-project", query="state=OPEN" ) print(request.execute()) ```
1175
- */
1176
- search(request?: {
1177
- /** V1 error format. */
1178
- "$.xgafv"?:
1179
- string;
1180
- /** OAuth access token. */
1181
- access_token?:
1182
- string;
1183
- /** Data format for response. */
1184
- alt?:
1185
- string;
1186
- /** JSONP */
1187
- callback?:
1188
- string;
1189
- /** Selector specifying which fields to include in a partial response. */
1190
- fields?:
1191
- string;
1192
- /** 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. */
1193
- key?:
1194
- string;
1195
- /** OAuth 2.0 token for the current user. */
1196
- oauth_token?:
1197
- string;
1198
- /** The maximum number of cases fetched with each request. The default page size is 10. */
1199
- pageSize?:
1200
- number;
1201
- /** A token identifying the page of results to return. If unspecified, the first page is retrieved. */
1202
- pageToken?:
1203
- string;
1204
- /** The name of the parent resource to search for cases under. */
1205
- parent:
1206
- string;
1207
- /** Returns response with indentations and line breaks. */
1208
- prettyPrint?:
1209
- boolean;
1210
- /**
1211
- * An expression used to filter cases. Expressions use the following fields separated by `AND` and specified with `=`: - `organization`: An organization name in the form
1212
- * `organizations/`. - `project`: A project name in the form `projects/`. - `state`: Can be `OPEN` or `CLOSED`. - `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You can
1213
- * 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. You must
1214
- * specify either `organization` or `project`. To search across `displayName`, `description`, and comments, use a global restriction with no keyword or operator. For example, `"my
1215
- * search"`. To search only cases updated after a certain date, use `update_time` restricted with that particular date, time, and timezone in ISO datetime format. For example,
1216
- * `update_time>"2020-01-01T00:00:00-05:00"`. `update_time` only supports the greater than operator (`>`). Examples: - `organization="organizations/123456789"` -
1217
- * `project="projects/my-project-id"` - `project="projects/123456789"` - `organization="organizations/123456789" AND state=CLOSED` - `project="projects/my-project-id" AND
1218
- * creator.email="tester@example.com"` - `project="projects/my-project-id" AND (priority=P0 OR priority=P1)`
1219
- */
1220
- query?:
1221
- string;
1222
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1223
- quotaUser?:
1224
- string;
1225
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1226
- upload_protocol?:
1227
- string;
1228
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1229
- uploadType?:
1230
- string;
1231
- }): Request<SearchCasesResponse>;
1232
- attachments:
1233
- AttachmentsResource;
1234
- comments:
1235
- CommentsResource;
1236
- }
1237
- interface MediaResource {
1238
- /**
1239
- * Download a file attached to a case. Note: HTTP requests must append "?alt=media" to the URL. EXAMPLES: cURL: ```shell
1240
- * name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \
1241
- * "https://cloudsupport.googleapis.com/v2/$name:download?alt=media" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService =
1242
- * googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", )
1243
- * request = supportApiService.media().download( name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" ) request.uri = request.uri.split("?")[0] + "?alt=media"
1244
- * print(request.execute()) ```
1245
- */
1246
- download(request?: {
1247
- /** V1 error format. */
1248
- "$.xgafv"?:
1249
- string;
1250
- /** OAuth access token. */
1251
- access_token?:
1252
- string;
1253
- /** Data format for response. */
1254
- alt?:
1255
- string;
1256
- /** JSONP */
1257
- callback?:
1258
- string;
1259
- /** Selector specifying which fields to include in a partial response. */
1260
- fields?:
1261
- string;
1262
- /** 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. */
1263
- key?:
1264
- string;
1265
- /** The name of the file attachment to download. */
1266
- name:
1267
- string;
1268
- /** OAuth 2.0 token for the current user. */
1269
- oauth_token?:
1270
- string;
1271
- /** Returns response with indentations and line breaks. */
1272
- prettyPrint?:
1273
- boolean;
1274
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1275
- quotaUser?:
1276
- string;
1277
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1278
- upload_protocol?:
1279
- string;
1280
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1281
- uploadType?:
1282
- string;
1283
- }): Request<Media>;
1284
- /**
1285
- * 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
1286
- * uploading using CSAPI." \ > "./example_file.txt" case="projects/some-project/cases/43594844" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \
1287
- * --data-binary @"./example_file.txt" \ "https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.filename=uploaded_via_curl.txt" ``` Python: ```python import
1288
- * googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version,
1289
- * 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(
1290
- * "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",
1291
- * media_body=file_path ) request.uri = request.uri.split("?")[0] + "?attachment.filename=uploaded_via_python.txt" print(request.execute()) ```
1292
- */
1293
- upload(request: {
1294
- /** V1 error format. */
1295
- "$.xgafv"?:
1296
- string;
1297
- /** OAuth access token. */
1298
- access_token?:
1299
- string;
1300
- /** Data format for response. */
1301
- alt?:
1302
- string;
1303
- /** JSONP */
1304
- callback?:
1305
- string;
1306
- /** Selector specifying which fields to include in a partial response. */
1307
- fields?:
1308
- string;
1309
- /** 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. */
1310
- key?:
1311
- string;
1312
- /** OAuth 2.0 token for the current user. */
1313
- oauth_token?:
1314
- string;
1315
- /** Required. The name of the case or Cloud resource to which the attachment should be attached. */
1316
- parent:
1317
- string;
1318
- /** Returns response with indentations and line breaks. */
1319
- prettyPrint?:
1320
- boolean;
1321
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1322
- quotaUser?:
1323
- string;
1324
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1325
- upload_protocol?:
1326
- string;
1327
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1328
- uploadType?:
1329
- string;
1330
- /** Request body */
1331
- resource:
1332
- CreateAttachmentRequest;
1333
- }): Request<Attachment>;
1334
- upload(request: {
1335
- /** V1 error format. */
1336
- "$.xgafv"?:
1337
- string;
1338
- /** OAuth access token. */
1339
- access_token?:
1340
- string;
1341
- /** Data format for response. */
1342
- alt?:
1343
- string;
1344
- /** JSONP */
1345
- callback?:
1346
- string;
1347
- /** Selector specifying which fields to include in a partial response. */
1348
- fields?:
1349
- string;
1350
- /** 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. */
1351
- key?:
1352
- string;
1353
- /** OAuth 2.0 token for the current user. */
1354
- oauth_token?:
1355
- string;
1356
- /** Required. The name of the case or Cloud resource to which the attachment should be attached. */
1357
- parent:
1358
- string;
1359
- /** Returns response with indentations and line breaks. */
1360
- prettyPrint?:
1361
- boolean;
1362
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1363
- quotaUser?:
1364
- string;
1365
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1366
- upload_protocol?:
1367
- string;
1368
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1369
- uploadType?:
1370
- string;
1371
- },
1372
- body: CreateAttachmentRequest): Request<Attachment>;
1373
- }
26
+ namespace cloudsupport {
27
+ interface Actor {
28
+ /** 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. */
29
+ displayName?: string;
30
+ /** 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. */
31
+ email?: string;
32
+ /** Output only. Whether the actor is a Google support actor. */
33
+ googleSupport?: boolean;
34
+ }
35
+ interface Attachment {
36
+ /** Output only. The time at which the attachment was created. */
37
+ createTime?: string;
38
+ /** Output only. The user who uploaded the attachment. Note, the name and email will be obfuscated if the attachment was uploaded by Google support. */
39
+ creator?: Actor;
40
+ /** The filename of the attachment (e.g. `"graph.jpg"`). */
41
+ filename?: string;
42
+ /** Output only. The MIME type of the attachment (e.g. text/plain). */
43
+ mimeType?: string;
44
+ /** Output only. The resource name of the attachment. */
45
+ name?: string;
46
+ /** Output only. The size of the attachment in bytes. */
47
+ sizeBytes?: string;
48
+ }
49
+ interface Blobstore2Info {
50
+ /** # gdata.* are outside protos with mising documentation */
51
+ blobGeneration?: string;
52
+ /** # gdata.* are outside protos with mising documentation */
53
+ blobId?: string;
54
+ /** # gdata.* are outside protos with mising documentation */
55
+ downloadReadHandle?: string;
56
+ /** # gdata.* are outside protos with mising documentation */
57
+ readToken?: string;
58
+ /** # gdata.* are outside protos with mising documentation */
59
+ uploadMetadataContainer?: string;
60
+ }
61
+ interface Case {
62
+ /** The issue classification applicable to this case. */
63
+ classification?: CaseClassification;
64
+ /** A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs. */
65
+ contactEmail?: string;
66
+ /** Output only. The time this case was created. */
67
+ createTime?: string;
68
+ /** The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support. */
69
+ creator?: Actor;
70
+ /** A broad description of the issue. */
71
+ description?: string;
72
+ /** The short summary of the issue reported in this case. */
73
+ displayName?: string;
74
+ /** Whether the case is currently escalated. */
75
+ escalated?: boolean;
76
+ /** The language the user has requested to receive support in. This should be a BCP 47 language code (e.g., `"en"`, `"zh-CN"`, `"zh-TW"`, `"ja"`, `"ko"`). If no language or an unsupported language is specified, this field defaults to English (en). Language selection during case creation may affect your available support options. For a list of supported languages and their support working hours, see: https://cloud.google.com/support/docs/language-working-hours */
77
+ languageCode?: string;
78
+ /** The resource name for the case. */
79
+ name?: string;
80
+ /** The priority of this case. */
81
+ priority?: string;
82
+ /** Output only. The current status of the support case. */
83
+ state?: string;
84
+ /** The email addresses to receive updates on this case. */
85
+ subscriberEmailAddresses?: string[];
86
+ /** Whether this case was created for internal API testing and should not be acted on by the support team. */
87
+ testCase?: boolean;
88
+ /** The timezone of the user who created the support case. It should be in a format IANA recognizes: https://www.iana.org/time-zones. There is no additional validation done by the API. */
89
+ timeZone?: string;
90
+ /** Output only. The time this case was last updated. */
91
+ updateTime?: string;
92
+ }
93
+ interface CaseClassification {
94
+ /** 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. */
95
+ displayName?: string;
96
+ /** 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. */
97
+ id?: string;
98
+ }
99
+ interface CloseCaseRequest {}
100
+ interface Comment {
101
+ /** The full comment body. Maximum of 12800 characters. This can contain rich text syntax. */
102
+ body?: string;
103
+ /** Output only. The time when this comment was created. */
104
+ createTime?: string;
105
+ /** Output only. The user or Google Support agent created this comment. */
106
+ creator?: Actor;
107
+ /** Output only. The resource name for the comment. */
108
+ name?: string;
109
+ /** Output only. DEPRECATED. An automatically generated plain text version of body with all rich text syntax stripped. */
110
+ plainTextBody?: string;
111
+ }
112
+ interface CompositeMedia {
113
+ /** # gdata.* are outside protos with mising documentation */
114
+ blobRef?: string;
115
+ /** # gdata.* are outside protos with mising documentation */
116
+ blobstore2Info?: Blobstore2Info;
117
+ /** # gdata.* are outside protos with mising documentation */
118
+ cosmoBinaryReference?: string;
119
+ /** # gdata.* are outside protos with mising documentation */
120
+ crc32cHash?: number;
121
+ /** # gdata.* are outside protos with mising documentation */
122
+ inline?: string;
123
+ /** # gdata.* are outside protos with mising documentation */
124
+ length?: string;
125
+ /** # gdata.* are outside protos with mising documentation */
126
+ md5Hash?: string;
127
+ /** # gdata.* are outside protos with mising documentation */
128
+ objectId?: ObjectId;
129
+ /** # gdata.* are outside protos with mising documentation */
130
+ path?: string;
131
+ /** # gdata.* are outside protos with mising documentation */
132
+ referenceType?: string;
133
+ /** # gdata.* are outside protos with mising documentation */
134
+ sha1Hash?: string;
135
+ }
136
+ interface ContentTypeInfo {
137
+ /** # gdata.* are outside protos with mising documentation */
138
+ bestGuess?: string;
139
+ /** # gdata.* are outside protos with mising documentation */
140
+ fromBytes?: string;
141
+ /** # gdata.* are outside protos with mising documentation */
142
+ fromFileName?: string;
143
+ /** # gdata.* are outside protos with mising documentation */
144
+ fromHeader?: string;
145
+ /** # gdata.* are outside protos with mising documentation */
146
+ fromUrlPath?: string;
147
+ }
148
+ interface CreateAttachmentRequest {
149
+ /** Required. The attachment to be created. */
150
+ attachment?: Attachment;
151
+ }
152
+ interface DiffChecksumsResponse {
153
+ /** # gdata.* are outside protos with mising documentation */
154
+ checksumsLocation?: CompositeMedia;
155
+ /** # gdata.* are outside protos with mising documentation */
156
+ chunkSizeBytes?: string;
157
+ /** # gdata.* are outside protos with mising documentation */
158
+ objectLocation?: CompositeMedia;
159
+ /** # gdata.* are outside protos with mising documentation */
160
+ objectSizeBytes?: string;
161
+ /** # gdata.* are outside protos with mising documentation */
162
+ objectVersion?: string;
163
+ }
164
+ interface DiffDownloadResponse {
165
+ /** # gdata.* are outside protos with mising documentation */
166
+ objectLocation?: CompositeMedia;
167
+ }
168
+ interface DiffUploadRequest {
169
+ /** # gdata.* are outside protos with mising documentation */
170
+ checksumsInfo?: CompositeMedia;
171
+ /** # gdata.* are outside protos with mising documentation */
172
+ objectInfo?: CompositeMedia;
173
+ /** # gdata.* are outside protos with mising documentation */
174
+ objectVersion?: string;
175
+ }
176
+ interface DiffUploadResponse {
177
+ /** # gdata.* are outside protos with mising documentation */
178
+ objectVersion?: string;
179
+ /** # gdata.* are outside protos with mising documentation */
180
+ originalObject?: CompositeMedia;
181
+ }
182
+ interface DiffVersionResponse {
183
+ /** # gdata.* are outside protos with mising documentation */
184
+ objectSizeBytes?: string;
185
+ /** # gdata.* are outside protos with mising documentation */
186
+ objectVersion?: string;
187
+ }
188
+ interface DownloadParameters {
189
+ /** # gdata.* are outside protos with mising documentation */
190
+ allowGzipCompression?: boolean;
191
+ /** # gdata.* are outside protos with mising documentation */
192
+ ignoreRange?: boolean;
193
+ }
194
+ interface EscalateCaseRequest {
195
+ /** The escalation information to be sent with the escalation request. */
196
+ escalation?: Escalation;
197
+ }
198
+ interface Escalation {
199
+ /** Required. A free text description to accompany the `reason` field above. Provides additional context on why the case is being escalated. */
200
+ justification?: string;
201
+ /** Required. The reason why the Case is being escalated. */
202
+ reason?: string;
203
+ }
204
+ interface ListAttachmentsResponse {
205
+ /** The list of attachments associated with a case. */
206
+ attachments?: Attachment[];
207
+ /** 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 retrieve. */
208
+ nextPageToken?: string;
209
+ }
210
+ interface ListCasesResponse {
211
+ /** The list of cases associated with the parent after any filters have been applied. */
212
+ cases?: Case[];
213
+ /** 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. */
214
+ nextPageToken?: string;
215
+ }
216
+ interface ListCommentsResponse {
217
+ /** List of the comments associated with the case. */
218
+ comments?: Comment[];
219
+ /** 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. */
220
+ nextPageToken?: string;
221
+ }
222
+ interface Media {
223
+ /** # gdata.* are outside protos with mising documentation */
224
+ algorithm?: string;
225
+ /** # gdata.* are outside protos with mising documentation */
226
+ bigstoreObjectRef?: string;
227
+ /** # gdata.* are outside protos with mising documentation */
228
+ blobRef?: string;
229
+ /** # gdata.* are outside protos with mising documentation */
230
+ blobstore2Info?: Blobstore2Info;
231
+ /** # gdata.* are outside protos with mising documentation */
232
+ compositeMedia?: CompositeMedia[];
233
+ /** # gdata.* are outside protos with mising documentation */
234
+ contentType?: string;
235
+ /** # gdata.* are outside protos with mising documentation */
236
+ contentTypeInfo?: ContentTypeInfo;
237
+ /** # gdata.* are outside protos with mising documentation */
238
+ cosmoBinaryReference?: string;
239
+ /** # gdata.* are outside protos with mising documentation */
240
+ crc32cHash?: number;
241
+ /** # gdata.* are outside protos with mising documentation */
242
+ diffChecksumsResponse?: DiffChecksumsResponse;
243
+ /** # gdata.* are outside protos with mising documentation */
244
+ diffDownloadResponse?: DiffDownloadResponse;
245
+ /** # gdata.* are outside protos with mising documentation */
246
+ diffUploadRequest?: DiffUploadRequest;
247
+ /** # gdata.* are outside protos with mising documentation */
248
+ diffUploadResponse?: DiffUploadResponse;
249
+ /** # gdata.* are outside protos with mising documentation */
250
+ diffVersionResponse?: DiffVersionResponse;
251
+ /** # gdata.* are outside protos with mising documentation */
252
+ downloadParameters?: DownloadParameters;
253
+ /** # gdata.* are outside protos with mising documentation */
254
+ filename?: string;
255
+ /** # gdata.* are outside protos with mising documentation */
256
+ hash?: string;
257
+ /** # gdata.* are outside protos with mising documentation */
258
+ hashVerified?: boolean;
259
+ /** # gdata.* are outside protos with mising documentation */
260
+ inline?: string;
261
+ /** # gdata.* are outside protos with mising documentation */
262
+ isPotentialRetry?: boolean;
263
+ /** # gdata.* are outside protos with mising documentation */
264
+ length?: string;
265
+ /** # gdata.* are outside protos with mising documentation */
266
+ md5Hash?: string;
267
+ /** # gdata.* are outside protos with mising documentation */
268
+ mediaId?: string;
269
+ /** # gdata.* are outside protos with mising documentation */
270
+ objectId?: ObjectId;
271
+ /** # gdata.* are outside protos with mising documentation */
272
+ path?: string;
273
+ /** # gdata.* are outside protos with mising documentation */
274
+ referenceType?: string;
275
+ /** # gdata.* are outside protos with mising documentation */
276
+ sha1Hash?: string;
277
+ /** # gdata.* are outside protos with mising documentation */
278
+ sha256Hash?: string;
279
+ /** # gdata.* are outside protos with mising documentation */
280
+ timestamp?: string;
281
+ /** # gdata.* are outside protos with mising documentation */
282
+ token?: string;
283
+ }
284
+ interface ObjectId {
285
+ /** # gdata.* are outside protos with mising documentation */
286
+ bucketName?: string;
287
+ /** # gdata.* are outside protos with mising documentation */
288
+ generation?: string;
289
+ /** # gdata.* are outside protos with mising documentation */
290
+ objectName?: string;
291
+ }
292
+ interface SearchCaseClassificationsResponse {
293
+ /** The classifications retrieved. */
294
+ caseClassifications?: CaseClassification[];
295
+ /** 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. */
296
+ nextPageToken?: string;
297
+ }
298
+ interface SearchCasesResponse {
299
+ /** The list of cases associated with the parent after any filters have been applied. */
300
+ cases?: Case[];
301
+ /** 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. */
302
+ nextPageToken?: string;
303
+ }
304
+ interface WorkflowOperationMetadata {
305
+ /** The namespace that the job was scheduled in. Must be included in the workflow metadata so the workflow status can be retrieved. */
306
+ namespace?: string;
307
+ /** The type of action the operation is classified as. */
308
+ operationAction?: string;
309
+ /** Which version of the workflow service this operation came from. */
310
+ workflowOperationType?: string;
311
+ }
312
+ interface CaseClassificationsResource {
313
+ /** Retrieve valid classifications to use when creating a support case. Classifications are hierarchical. Each classification is a string containing all levels of the hierarchy separated by `" > "`. For example, `"Technical Issue > Compute > Compute Engine"`. Classification IDs returned by this endpoint are valid for at least six months. When a classification is deactivated, this endpoint immediately stops returning it. After six months, `case.create` requests using the classification will fail. EXAMPLES: cURL: ```shell curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ 'https://cloudsupport.googleapis.com/v2/caseClassifications:search?query=display_name:"*Compute%20Engine*"' ``` Python: ```python import googleapiclient.discovery supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version="v2", discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=v2", ) request = supportApiService.caseClassifications().search( query='display_name:"*Compute Engine*"' ) print(request.execute()) ``` */
314
+ search(request?: {
315
+ /** V1 error format. */
316
+ '$.xgafv'?: string;
317
+ /** OAuth access token. */
318
+ access_token?: string;
319
+ /** Data format for response. */
320
+ alt?: string;
321
+ /** JSONP */
322
+ callback?: string;
323
+ /** Selector specifying which fields to include in a partial response. */
324
+ fields?: string;
325
+ /** 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. */
326
+ key?: string;
327
+ /** OAuth 2.0 token for the current user. */
328
+ oauth_token?: string;
329
+ /** The maximum number of classifications fetched with each request. */
330
+ pageSize?: number;
331
+ /** A token identifying the page of results to return. If unspecified, the first page is retrieved. */
332
+ pageToken?: string;
333
+ /** Returns response with indentations and line breaks. */
334
+ prettyPrint?: boolean;
335
+ /** 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. */
336
+ query?: string;
337
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
338
+ quotaUser?: string;
339
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
340
+ upload_protocol?: string;
341
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
342
+ uploadType?: string;
343
+ }): Request<SearchCaseClassificationsResponse>;
344
+ }
345
+ interface AttachmentsResource {
346
+ /** List all the attachments associated with a support case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/23598314" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/attachments" ``` 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.cases() .attachments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ``` */
347
+ list(request?: {
348
+ /** V1 error format. */
349
+ '$.xgafv'?: string;
350
+ /** OAuth access token. */
351
+ access_token?: string;
352
+ /** Data format for response. */
353
+ alt?: string;
354
+ /** JSONP */
355
+ callback?: string;
356
+ /** Selector specifying which fields to include in a partial response. */
357
+ fields?: string;
358
+ /** 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. */
359
+ key?: string;
360
+ /** OAuth 2.0 token for the current user. */
361
+ oauth_token?: string;
362
+ /** The maximum number of attachments fetched with each request. If not provided, the default is 10. The maximum page size that will be returned is 100. */
363
+ pageSize?: number;
364
+ /** A token identifying the page of results to return. If unspecified, the first page is retrieved. */
365
+ pageToken?: string;
366
+ /** Required. The name of the case for which attachments should be listed. */
367
+ parent: string;
368
+ /** Returns response with indentations and line breaks. */
369
+ prettyPrint?: boolean;
370
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
371
+ quotaUser?: string;
372
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
373
+ upload_protocol?: string;
374
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
375
+ uploadType?: string;
376
+ }): Request<ListAttachmentsResponse>;
377
+ }
378
+ interface CommentsResource {
379
+ /** 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 \ --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" ``` 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.cases() .comments() .create( parent="projects/some-project/cases/43595344", body={"body": "This is a test comment."}, ) ) print(request.execute()) ``` */
380
+ create(request: {
381
+ /** V1 error format. */
382
+ '$.xgafv'?: string;
383
+ /** OAuth access token. */
384
+ access_token?: string;
385
+ /** Data format for response. */
386
+ alt?: string;
387
+ /** JSONP */
388
+ callback?: string;
389
+ /** Selector specifying which fields to include in a partial response. */
390
+ fields?: string;
391
+ /** 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. */
392
+ key?: string;
393
+ /** OAuth 2.0 token for the current user. */
394
+ oauth_token?: string;
395
+ /** Required. The name of the case to which the comment should be added. */
396
+ parent: string;
397
+ /** Returns response with indentations and line breaks. */
398
+ prettyPrint?: boolean;
399
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
400
+ quotaUser?: string;
401
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
402
+ upload_protocol?: string;
403
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
404
+ uploadType?: string;
405
+ /** Request body */
406
+ resource: Comment;
407
+ }): Request<Comment>;
408
+ create(
409
+ request: {
410
+ /** V1 error format. */
411
+ '$.xgafv'?: string;
412
+ /** OAuth access token. */
413
+ access_token?: string;
414
+ /** Data format for response. */
415
+ alt?: string;
416
+ /** JSONP */
417
+ callback?: string;
418
+ /** Selector specifying which fields to include in a partial response. */
419
+ fields?: string;
420
+ /** 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. */
421
+ key?: string;
422
+ /** OAuth 2.0 token for the current user. */
423
+ oauth_token?: string;
424
+ /** Required. The name of the case to which the comment should be added. */
425
+ parent: string;
426
+ /** Returns response with indentations and line breaks. */
427
+ prettyPrint?: boolean;
428
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
429
+ quotaUser?: string;
430
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
431
+ upload_protocol?: string;
432
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
433
+ uploadType?: string;
434
+ },
435
+ body: Comment
436
+ ): Request<Comment>;
437
+ /** List all the comments associated with a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/comments" ``` 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.cases() .comments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ``` */
438
+ list(request?: {
439
+ /** V1 error format. */
440
+ '$.xgafv'?: string;
441
+ /** OAuth access token. */
442
+ access_token?: string;
443
+ /** Data format for response. */
444
+ alt?: string;
445
+ /** JSONP */
446
+ callback?: string;
447
+ /** Selector specifying which fields to include in a partial response. */
448
+ fields?: string;
449
+ /** 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. */
450
+ key?: string;
451
+ /** OAuth 2.0 token for the current user. */
452
+ oauth_token?: string;
453
+ /** The maximum number of comments to fetch. Defaults to 10. */
454
+ pageSize?: number;
455
+ /** A token identifying the page of results to return. If unspecified, the first page is returned. */
456
+ pageToken?: string;
457
+ /** Required. The name of the case for which to list comments. */
458
+ parent: string;
459
+ /** Returns response with indentations and line breaks. */
460
+ prettyPrint?: boolean;
461
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
462
+ quotaUser?: string;
463
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
464
+ upload_protocol?: string;
465
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
466
+ uploadType?: string;
467
+ }): Request<ListCommentsResponse>;
468
+ }
469
+ interface CasesResource {
470
+ /** Close a case. EXAMPLES: 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" ``` 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.cases().close( name="projects/some-project/cases/43595344" ) print(request.execute()) ``` */
471
+ close(request: {
472
+ /** V1 error format. */
473
+ '$.xgafv'?: string;
474
+ /** OAuth access token. */
475
+ access_token?: string;
476
+ /** Data format for response. */
477
+ alt?: string;
478
+ /** JSONP */
479
+ callback?: string;
480
+ /** Selector specifying which fields to include in a partial response. */
481
+ fields?: string;
482
+ /** 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. */
483
+ key?: string;
484
+ /** Required. The name of the case to close. */
485
+ name: string;
486
+ /** OAuth 2.0 token for the current user. */
487
+ oauth_token?: string;
488
+ /** Returns response with indentations and line breaks. */
489
+ prettyPrint?: boolean;
490
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
491
+ quotaUser?: string;
492
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
493
+ upload_protocol?: string;
494
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
495
+ uploadType?: string;
496
+ /** Request body */
497
+ resource: CloseCaseRequest;
498
+ }): Request<Case>;
499
+ close(
500
+ request: {
501
+ /** V1 error format. */
502
+ '$.xgafv'?: string;
503
+ /** OAuth access token. */
504
+ access_token?: string;
505
+ /** Data format for response. */
506
+ alt?: string;
507
+ /** JSONP */
508
+ callback?: string;
509
+ /** Selector specifying which fields to include in a partial response. */
510
+ fields?: string;
511
+ /** 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. */
512
+ key?: string;
513
+ /** Required. The name of the case to close. */
514
+ name: string;
515
+ /** OAuth 2.0 token for the current user. */
516
+ oauth_token?: string;
517
+ /** Returns response with indentations and line breaks. */
518
+ prettyPrint?: boolean;
519
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
520
+ quotaUser?: string;
521
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
522
+ upload_protocol?: string;
523
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
524
+ uploadType?: string;
525
+ },
526
+ body: CloseCaseRequest
527
+ ): Request<Case>;
528
+ /** Create a new case and associate it with a parent. It 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`. EXAMPLES: 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": "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" }, "time_zone": "-07:00", "subscriber_email_addresses": [ "foo@domain.com", "bar@domain.com" ], "testCase": true, "priority": "P3" }' \ "https://cloudsupport.googleapis.com/v2/$parent/cases" ``` 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.cases().create( parent="projects/some-project", body={ "displayName": "A Test Case", "description": "This is a test case.", "testCase": True, "priority": "P2", "classification": { "id": "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" }, }, ) print(request.execute()) ``` */
529
+ create(request: {
530
+ /** V1 error format. */
531
+ '$.xgafv'?: string;
532
+ /** OAuth access token. */
533
+ access_token?: string;
534
+ /** Data format for response. */
535
+ alt?: string;
536
+ /** JSONP */
537
+ callback?: string;
538
+ /** Selector specifying which fields to include in a partial response. */
539
+ fields?: string;
540
+ /** 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. */
541
+ key?: string;
542
+ /** OAuth 2.0 token for the current user. */
543
+ oauth_token?: string;
544
+ /** Required. The name of the parent under which the case should be created. */
545
+ parent: string;
546
+ /** Returns response with indentations and line breaks. */
547
+ prettyPrint?: boolean;
548
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
549
+ quotaUser?: string;
550
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
551
+ upload_protocol?: string;
552
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
553
+ uploadType?: string;
554
+ /** Request body */
555
+ resource: Case;
556
+ }): Request<Case>;
557
+ create(
558
+ request: {
559
+ /** V1 error format. */
560
+ '$.xgafv'?: string;
561
+ /** OAuth access token. */
562
+ access_token?: string;
563
+ /** Data format for response. */
564
+ alt?: string;
565
+ /** JSONP */
566
+ callback?: string;
567
+ /** Selector specifying which fields to include in a partial response. */
568
+ fields?: string;
569
+ /** 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. */
570
+ key?: string;
571
+ /** OAuth 2.0 token for the current user. */
572
+ oauth_token?: string;
573
+ /** Required. The name of the parent under which the case should be created. */
574
+ parent: string;
575
+ /** Returns response with indentations and line breaks. */
576
+ prettyPrint?: boolean;
577
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
578
+ quotaUser?: string;
579
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
580
+ upload_protocol?: string;
581
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
582
+ uploadType?: string;
583
+ },
584
+ body: Case
585
+ ): Request<Case>;
586
+ /** Escalate a case, starting the Google Cloud Support escalation management process. This operation is only available for some support services. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which ones let you do that. EXAMPLES: 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" ``` 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.cases().escalate( name="projects/some-project/cases/43595344", body={ "escalation": { "reason": "BUSINESS_IMPACT", "justification": "This is a test escalation.", }, }, ) print(request.execute()) ``` */
587
+ escalate(request: {
588
+ /** V1 error format. */
589
+ '$.xgafv'?: string;
590
+ /** OAuth access token. */
591
+ access_token?: string;
592
+ /** Data format for response. */
593
+ alt?: string;
594
+ /** JSONP */
595
+ callback?: string;
596
+ /** Selector specifying which fields to include in a partial response. */
597
+ fields?: string;
598
+ /** 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. */
599
+ key?: string;
600
+ /** Required. The name of the case to be escalated. */
601
+ name: string;
602
+ /** OAuth 2.0 token for the current user. */
603
+ oauth_token?: string;
604
+ /** Returns response with indentations and line breaks. */
605
+ prettyPrint?: boolean;
606
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
607
+ quotaUser?: string;
608
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
609
+ upload_protocol?: string;
610
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
611
+ uploadType?: string;
612
+ /** Request body */
613
+ resource: EscalateCaseRequest;
614
+ }): Request<Case>;
615
+ escalate(
616
+ request: {
617
+ /** V1 error format. */
618
+ '$.xgafv'?: string;
619
+ /** OAuth access token. */
620
+ access_token?: string;
621
+ /** Data format for response. */
622
+ alt?: string;
623
+ /** JSONP */
624
+ callback?: string;
625
+ /** Selector specifying which fields to include in a partial response. */
626
+ fields?: string;
627
+ /** 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. */
628
+ key?: string;
629
+ /** Required. The name of the case to be escalated. */
630
+ name: string;
631
+ /** OAuth 2.0 token for the current user. */
632
+ oauth_token?: string;
633
+ /** Returns response with indentations and line breaks. */
634
+ prettyPrint?: boolean;
635
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
636
+ quotaUser?: string;
637
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
638
+ upload_protocol?: string;
639
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
640
+ uploadType?: string;
641
+ },
642
+ body: EscalateCaseRequest
643
+ ): Request<Case>;
644
+ /** Retrieve a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/16033687" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case" ``` 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.cases().get( name="projects/some-project/cases/43595344", ) print(request.execute()) ``` */
645
+ get(request?: {
646
+ /** V1 error format. */
647
+ '$.xgafv'?: string;
648
+ /** OAuth access token. */
649
+ access_token?: string;
650
+ /** Data format for response. */
651
+ alt?: string;
652
+ /** JSONP */
653
+ callback?: string;
654
+ /** Selector specifying which fields to include in a partial response. */
655
+ fields?: string;
656
+ /** 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. */
657
+ key?: string;
658
+ /** Required. The full name of a case to be retrieved. */
659
+ name: string;
660
+ /** OAuth 2.0 token for the current user. */
661
+ oauth_token?: string;
662
+ /** Returns response with indentations and line breaks. */
663
+ prettyPrint?: boolean;
664
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
665
+ quotaUser?: string;
666
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
667
+ upload_protocol?: string;
668
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
669
+ uploadType?: string;
670
+ }): Request<Case>;
671
+ /** Retrieve all cases under a parent, but not its children. For example, listing cases under an organization only returns the cases that are directly parented by that organization. To retrieve cases under an organization and its projects, use `cases.search`. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$parent/cases" ``` 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.cases().list(parent="projects/some-project") print(request.execute()) ``` */
672
+ list(request?: {
673
+ /** V1 error format. */
674
+ '$.xgafv'?: string;
675
+ /** OAuth access token. */
676
+ access_token?: string;
677
+ /** Data format for response. */
678
+ alt?: string;
679
+ /** JSONP */
680
+ callback?: string;
681
+ /** Selector specifying which fields to include in a partial response. */
682
+ fields?: string;
683
+ /** An expression used to filter cases. If it's an empty string, then no filtering happens. Otherwise, the endpoint returns the cases that match the filter. 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: - `state=CLOSED` - `state=OPEN AND creator.email="tester@example.com"` - `state=OPEN AND (priority=P0 OR priority=P1)` */
684
+ filter?: string;
685
+ /** 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. */
686
+ key?: string;
687
+ /** OAuth 2.0 token for the current user. */
688
+ oauth_token?: string;
689
+ /** The maximum number of cases fetched with each request. Defaults to 10. */
690
+ pageSize?: number;
691
+ /** A token identifying the page of results to return. If unspecified, the first page is retrieved. */
692
+ pageToken?: string;
693
+ /** Required. The name of a parent to list cases under. */
694
+ parent: string;
695
+ /** Returns response with indentations and line breaks. */
696
+ prettyPrint?: boolean;
697
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
698
+ quotaUser?: string;
699
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
700
+ upload_protocol?: string;
701
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
702
+ uploadType?: string;
703
+ }): Request<ListCasesResponse>;
704
+ /** Update a case. Only some fields can be updated. EXAMPLES: 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" ``` 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.cases().patch( name="projects/some-project/cases/43112854", body={ "displayName": "This is Now a New Title", "priority": "P2", }, ) print(request.execute()) ``` */
705
+ patch(request: {
706
+ /** V1 error format. */
707
+ '$.xgafv'?: string;
708
+ /** OAuth access token. */
709
+ access_token?: string;
710
+ /** Data format for response. */
711
+ alt?: string;
712
+ /** JSONP */
713
+ callback?: string;
714
+ /** Selector specifying which fields to include in a partial response. */
715
+ fields?: string;
716
+ /** 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. */
717
+ key?: string;
718
+ /** The resource name for the case. */
719
+ name: string;
720
+ /** OAuth 2.0 token for the current user. */
721
+ oauth_token?: string;
722
+ /** Returns response with indentations and line breaks. */
723
+ prettyPrint?: boolean;
724
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
725
+ quotaUser?: string;
726
+ /** 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. 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. */
727
+ updateMask?: string;
728
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
729
+ upload_protocol?: string;
730
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
731
+ uploadType?: string;
732
+ /** Request body */
733
+ resource: Case;
734
+ }): Request<Case>;
735
+ patch(
736
+ request: {
737
+ /** V1 error format. */
738
+ '$.xgafv'?: string;
739
+ /** OAuth access token. */
740
+ access_token?: string;
741
+ /** Data format for response. */
742
+ alt?: string;
743
+ /** JSONP */
744
+ callback?: string;
745
+ /** Selector specifying which fields to include in a partial response. */
746
+ fields?: string;
747
+ /** 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. */
748
+ key?: string;
749
+ /** The resource name for the case. */
750
+ name: string;
751
+ /** OAuth 2.0 token for the current user. */
752
+ oauth_token?: string;
753
+ /** Returns response with indentations and line breaks. */
754
+ prettyPrint?: boolean;
755
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
756
+ quotaUser?: string;
757
+ /** 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. 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. */
758
+ updateMask?: string;
759
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
760
+ upload_protocol?: string;
761
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
762
+ uploadType?: string;
763
+ },
764
+ body: Case
765
+ ): Request<Case>;
766
+ /** Search for cases using a query. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$parent/cases:search" ``` 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.cases().search( parent="projects/some-project", query="state=OPEN" ) print(request.execute()) ``` */
767
+ search(request?: {
768
+ /** V1 error format. */
769
+ '$.xgafv'?: string;
770
+ /** OAuth access token. */
771
+ access_token?: string;
772
+ /** Data format for response. */
773
+ alt?: string;
774
+ /** JSONP */
775
+ callback?: string;
776
+ /** Selector specifying which fields to include in a partial response. */
777
+ fields?: string;
778
+ /** 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. */
779
+ key?: string;
780
+ /** OAuth 2.0 token for the current user. */
781
+ oauth_token?: string;
782
+ /** The maximum number of cases fetched with each request. The default page size is 10. */
783
+ pageSize?: number;
784
+ /** A token identifying the page of results to return. If unspecified, the first page is retrieved. */
785
+ pageToken?: string;
786
+ /** The name of the parent resource to search for cases under. */
787
+ parent: string;
788
+ /** Returns response with indentations and line breaks. */
789
+ prettyPrint?: boolean;
790
+ /** An expression used to filter cases. Expressions use the following fields separated by `AND` and specified with `=`: - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. - `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. You must specify either `organization` or `project`. To search across `displayName`, `description`, and comments, use a global restriction with no keyword or operator. For example, `"my search"`. To search only cases updated after a certain date, use `update_time` restricted with that particular date, time, and timezone in ISO datetime format. For example, `update_time>"2020-01-01T00:00:00-05:00"`. `update_time` only supports the greater than operator (`>`). Examples: - `organization="organizations/123456789"` - `project="projects/my-project-id"` - `project="projects/123456789"` - `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)` */
791
+ query?: string;
792
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
793
+ quotaUser?: string;
794
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
795
+ upload_protocol?: string;
796
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
797
+ uploadType?: string;
798
+ }): Request<SearchCasesResponse>;
799
+ attachments: AttachmentsResource;
800
+ comments: CommentsResource;
801
+ }
802
+ interface MediaResource {
803
+ /** 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()) ``` */
804
+ download(request?: {
805
+ /** V1 error format. */
806
+ '$.xgafv'?: string;
807
+ /** OAuth access token. */
808
+ access_token?: string;
809
+ /** Data format for response. */
810
+ alt?: string;
811
+ /** JSONP */
812
+ callback?: string;
813
+ /** Selector specifying which fields to include in a partial response. */
814
+ fields?: string;
815
+ /** 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. */
816
+ key?: string;
817
+ /** The name of the file attachment to download. */
818
+ name: string;
819
+ /** OAuth 2.0 token for the current user. */
820
+ oauth_token?: string;
821
+ /** Returns response with indentations and line breaks. */
822
+ prettyPrint?: boolean;
823
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
824
+ quotaUser?: string;
825
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
826
+ upload_protocol?: string;
827
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
828
+ uploadType?: string;
829
+ }): Request<Media>;
830
+ /** 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()) ``` */
831
+ upload(request: {
832
+ /** V1 error format. */
833
+ '$.xgafv'?: string;
834
+ /** OAuth access token. */
835
+ access_token?: string;
836
+ /** Data format for response. */
837
+ alt?: string;
838
+ /** JSONP */
839
+ callback?: string;
840
+ /** Selector specifying which fields to include in a partial response. */
841
+ fields?: string;
842
+ /** 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. */
843
+ key?: string;
844
+ /** OAuth 2.0 token for the current user. */
845
+ oauth_token?: string;
846
+ /** Required. The name of the case or Cloud resource to which the attachment should be attached. */
847
+ parent: string;
848
+ /** Returns response with indentations and line breaks. */
849
+ prettyPrint?: boolean;
850
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
851
+ quotaUser?: string;
852
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
853
+ upload_protocol?: string;
854
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
855
+ uploadType?: string;
856
+ /** Request body */
857
+ resource: CreateAttachmentRequest;
858
+ }): Request<Attachment>;
859
+ upload(
860
+ request: {
861
+ /** V1 error format. */
862
+ '$.xgafv'?: string;
863
+ /** OAuth access token. */
864
+ access_token?: string;
865
+ /** Data format for response. */
866
+ alt?: string;
867
+ /** JSONP */
868
+ callback?: string;
869
+ /** Selector specifying which fields to include in a partial response. */
870
+ fields?: string;
871
+ /** 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. */
872
+ key?: string;
873
+ /** OAuth 2.0 token for the current user. */
874
+ oauth_token?: string;
875
+ /** Required. The name of the case or Cloud resource to which the attachment should be attached. */
876
+ parent: string;
877
+ /** Returns response with indentations and line breaks. */
878
+ prettyPrint?: boolean;
879
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
880
+ quotaUser?: string;
881
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
882
+ upload_protocol?: string;
883
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
884
+ uploadType?: string;
885
+ },
886
+ body: CreateAttachmentRequest
887
+ ): Request<Attachment>;
888
+ }
1374
889
 
1375
- const caseClassifications: CaseClassificationsResource;
890
+ const caseClassifications: CaseClassificationsResource;
1376
891
 
1377
- const cases: CasesResource;
892
+ const cases: CasesResource;
1378
893
 
1379
- const media: MediaResource;
1380
- }
894
+ const media: MediaResource;
895
+ }
1381
896
  }