v1.d.ts
32.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace mybusinessplaceactions_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* 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.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* 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.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* My Business Place Actions API
*
* The My Business Place Actions API provides an interface for managing place action links of a location on Google.
*
* @example
* ```js
* const {google} = require('googleapis');
* const mybusinessplaceactions = google.mybusinessplaceactions('v1');
* ```
*/
export class Mybusinessplaceactions {
context: APIRequestContext;
locations: Resource$Locations;
placeActionTypeMetadata: Resource$Placeactiontypemetadata;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} The JSON representation for `Empty` is empty JSON object `{\}`.
*/
export interface Schema$Empty {
}
/**
* Response message for PlaceActions.ListPlaceActionLinks.
*/
export interface Schema$ListPlaceActionLinksResponse {
/**
* If there are more place action links than the requested page size, then this field is populated with a token to fetch the next page of results.
*/
nextPageToken?: string | null;
/**
* The returned list of place action links.
*/
placeActionLinks?: Schema$PlaceActionLink[];
}
/**
* Response message for PlaceActions.ListPlaceActionTypeMetadata.
*/
export interface Schema$ListPlaceActionTypeMetadataResponse {
/**
* If the number of action types exceeded the requested page size, this field will be populated with a token to fetch the next page on a subsequent call to `placeActionTypeMetadata.list`. If there are no more results, this field will not be present in the response.
*/
nextPageToken?: string | null;
/**
* A collection of metadata for the available place action types.
*/
placeActionTypeMetadata?: Schema$PlaceActionTypeMetadata[];
}
/**
* Represents a place action link and its attributes.
*/
export interface Schema$PlaceActionLink {
/**
* Output only. The time when the place action link was created.
*/
createTime?: string | null;
/**
* Output only. Indicates whether this link can be edited by the client.
*/
isEditable?: boolean | null;
/**
* Optional. Whether this link is preferred by the merchant. Only one link can be marked as preferred per place action type at a location. If a future request marks a different link as preferred for the same place action type, then the current preferred link (if any exists) will lose its preference.
*/
isPreferred?: boolean | null;
/**
* Optional. The resource name, in the format `locations/{location_id\}/placeActionLinks/{place_action_link_id\}`. The name field will only be considered in UpdatePlaceActionLink and DeletePlaceActionLink requests for updating and deleting links respectively. However, it will be ignored in CreatePlaceActionLink request, where `place_action_link_id` will be assigned by the server on successful creation of a new link and returned as part of the response.
*/
name?: string | null;
/**
* Required. The type of place action that can be performed using this link.
*/
placeActionType?: string | null;
/**
* Output only. Specifies the provider type.
*/
providerType?: string | null;
/**
* Output only. The time when the place action link was last modified.
*/
updateTime?: string | null;
/**
* Required. The link uri. The same uri can be reused for different action types across different locations. However, only one place action link is allowed for each unique combination of (uri, place action type, location).
*/
uri?: string | null;
}
/**
* Metadata for supported place action types.
*/
export interface Schema$PlaceActionTypeMetadata {
/**
* The localized display name for the attribute, if available; otherwise, the English display name.
*/
displayName?: string | null;
/**
* The place action type.
*/
placeActionType?: string | null;
}
export class Resource$Locations {
context: APIRequestContext;
placeActionLinks: Resource$Locations$Placeactionlinks;
constructor(context: APIRequestContext);
}
export class Resource$Locations$Placeactionlinks {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Creates a place action link associated with the specified location, and returns it. The request is considered duplicate if the `parent`, `place_action_link.uri` and `place_action_link.place_action_type` are the same as a previous request.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/mybusinessplaceactions.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const mybusinessplaceactions = google.mybusinessplaceactions('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await mybusinessplaceactions.locations.placeActionLinks.create({
* // Required. The resource name of the location where to create this place action link. `locations/{location_id\}`.
* parent: 'locations/my-location',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "createTime": "my_createTime",
* // "isEditable": false,
* // "isPreferred": false,
* // "name": "my_name",
* // "placeActionType": "my_placeActionType",
* // "providerType": "my_providerType",
* // "updateTime": "my_updateTime",
* // "uri": "my_uri"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "createTime": "my_createTime",
* // "isEditable": false,
* // "isPreferred": false,
* // "name": "my_name",
* // "placeActionType": "my_placeActionType",
* // "providerType": "my_providerType",
* // "updateTime": "my_updateTime",
* // "uri": "my_uri"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Locations$Placeactionlinks$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Locations$Placeactionlinks$Create, options?: MethodOptions): GaxiosPromise<Schema$PlaceActionLink>;
create(params: Params$Resource$Locations$Placeactionlinks$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Locations$Placeactionlinks$Create, options: MethodOptions | BodyResponseCallback<Schema$PlaceActionLink>, callback: BodyResponseCallback<Schema$PlaceActionLink>): void;
create(params: Params$Resource$Locations$Placeactionlinks$Create, callback: BodyResponseCallback<Schema$PlaceActionLink>): void;
create(callback: BodyResponseCallback<Schema$PlaceActionLink>): void;
/**
* Deletes a place action link from the specified location.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/mybusinessplaceactions.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const mybusinessplaceactions = google.mybusinessplaceactions('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await mybusinessplaceactions.locations.placeActionLinks.delete({
* // Required. The resource name of the place action link to remove from the location.
* name: 'locations/my-location/placeActionLinks/my-placeActionLink',
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(params: Params$Resource$Locations$Placeactionlinks$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
delete(params?: Params$Resource$Locations$Placeactionlinks$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Locations$Placeactionlinks$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
delete(params: Params$Resource$Locations$Placeactionlinks$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Locations$Placeactionlinks$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* Gets the specified place action link.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/mybusinessplaceactions.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const mybusinessplaceactions = google.mybusinessplaceactions('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await mybusinessplaceactions.locations.placeActionLinks.get({
* // Required. The name of the place action link to fetch.
* name: 'locations/my-location/placeActionLinks/my-placeActionLink',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "createTime": "my_createTime",
* // "isEditable": false,
* // "isPreferred": false,
* // "name": "my_name",
* // "placeActionType": "my_placeActionType",
* // "providerType": "my_providerType",
* // "updateTime": "my_updateTime",
* // "uri": "my_uri"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Locations$Placeactionlinks$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Locations$Placeactionlinks$Get, options?: MethodOptions): GaxiosPromise<Schema$PlaceActionLink>;
get(params: Params$Resource$Locations$Placeactionlinks$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Locations$Placeactionlinks$Get, options: MethodOptions | BodyResponseCallback<Schema$PlaceActionLink>, callback: BodyResponseCallback<Schema$PlaceActionLink>): void;
get(params: Params$Resource$Locations$Placeactionlinks$Get, callback: BodyResponseCallback<Schema$PlaceActionLink>): void;
get(callback: BodyResponseCallback<Schema$PlaceActionLink>): void;
/**
* Lists the place action links for the specified location.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/mybusinessplaceactions.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const mybusinessplaceactions = google.mybusinessplaceactions('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await mybusinessplaceactions.locations.placeActionLinks.list({
* // Optional. A filter constraining the place action links to return. The response includes entries that match the filter. We support only the following filter: 1. place_action_type=XYZ where XYZ is a valid PlaceActionType.
* filter: 'placeholder-value',
* // Optional. How many place action links to return per page. Default of 10. The minimum is 1.
* pageSize: 'placeholder-value',
* // Optional. If specified, returns the next page of place action links.
* pageToken: 'placeholder-value',
* // Required. The name of the location whose place action links will be listed. `locations/{location_id\}`.
* parent: 'locations/my-location',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "placeActionLinks": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Locations$Placeactionlinks$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Locations$Placeactionlinks$List, options?: MethodOptions): GaxiosPromise<Schema$ListPlaceActionLinksResponse>;
list(params: Params$Resource$Locations$Placeactionlinks$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Locations$Placeactionlinks$List, options: MethodOptions | BodyResponseCallback<Schema$ListPlaceActionLinksResponse>, callback: BodyResponseCallback<Schema$ListPlaceActionLinksResponse>): void;
list(params: Params$Resource$Locations$Placeactionlinks$List, callback: BodyResponseCallback<Schema$ListPlaceActionLinksResponse>): void;
list(callback: BodyResponseCallback<Schema$ListPlaceActionLinksResponse>): void;
/**
* Updates the specified place action link and returns it.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/mybusinessplaceactions.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const mybusinessplaceactions = google.mybusinessplaceactions('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await mybusinessplaceactions.locations.placeActionLinks.patch({
* // Optional. The resource name, in the format `locations/{location_id\}/placeActionLinks/{place_action_link_id\}`. The name field will only be considered in UpdatePlaceActionLink and DeletePlaceActionLink requests for updating and deleting links respectively. However, it will be ignored in CreatePlaceActionLink request, where `place_action_link_id` will be assigned by the server on successful creation of a new link and returned as part of the response.
* name: 'locations/my-location/placeActionLinks/my-placeActionLink',
* // Required. The specific fields to update. The only editable fields are `uri`, `place_action_type` and `is_preferred`. If the updated link already exists at the same location with the same `place_action_type` and `uri`, fails with an `ALREADY_EXISTS` error.
* updateMask: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "createTime": "my_createTime",
* // "isEditable": false,
* // "isPreferred": false,
* // "name": "my_name",
* // "placeActionType": "my_placeActionType",
* // "providerType": "my_providerType",
* // "updateTime": "my_updateTime",
* // "uri": "my_uri"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "createTime": "my_createTime",
* // "isEditable": false,
* // "isPreferred": false,
* // "name": "my_name",
* // "placeActionType": "my_placeActionType",
* // "providerType": "my_providerType",
* // "updateTime": "my_updateTime",
* // "uri": "my_uri"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
patch(params: Params$Resource$Locations$Placeactionlinks$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
patch(params?: Params$Resource$Locations$Placeactionlinks$Patch, options?: MethodOptions): GaxiosPromise<Schema$PlaceActionLink>;
patch(params: Params$Resource$Locations$Placeactionlinks$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
patch(params: Params$Resource$Locations$Placeactionlinks$Patch, options: MethodOptions | BodyResponseCallback<Schema$PlaceActionLink>, callback: BodyResponseCallback<Schema$PlaceActionLink>): void;
patch(params: Params$Resource$Locations$Placeactionlinks$Patch, callback: BodyResponseCallback<Schema$PlaceActionLink>): void;
patch(callback: BodyResponseCallback<Schema$PlaceActionLink>): void;
}
export interface Params$Resource$Locations$Placeactionlinks$Create extends StandardParameters {
/**
* Required. The resource name of the location where to create this place action link. `locations/{location_id\}`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$PlaceActionLink;
}
export interface Params$Resource$Locations$Placeactionlinks$Delete extends StandardParameters {
/**
* Required. The resource name of the place action link to remove from the location.
*/
name?: string;
}
export interface Params$Resource$Locations$Placeactionlinks$Get extends StandardParameters {
/**
* Required. The name of the place action link to fetch.
*/
name?: string;
}
export interface Params$Resource$Locations$Placeactionlinks$List extends StandardParameters {
/**
* Optional. A filter constraining the place action links to return. The response includes entries that match the filter. We support only the following filter: 1. place_action_type=XYZ where XYZ is a valid PlaceActionType.
*/
filter?: string;
/**
* Optional. How many place action links to return per page. Default of 10. The minimum is 1.
*/
pageSize?: number;
/**
* Optional. If specified, returns the next page of place action links.
*/
pageToken?: string;
/**
* Required. The name of the location whose place action links will be listed. `locations/{location_id\}`.
*/
parent?: string;
}
export interface Params$Resource$Locations$Placeactionlinks$Patch extends StandardParameters {
/**
* Optional. The resource name, in the format `locations/{location_id\}/placeActionLinks/{place_action_link_id\}`. The name field will only be considered in UpdatePlaceActionLink and DeletePlaceActionLink requests for updating and deleting links respectively. However, it will be ignored in CreatePlaceActionLink request, where `place_action_link_id` will be assigned by the server on successful creation of a new link and returned as part of the response.
*/
name?: string;
/**
* Required. The specific fields to update. The only editable fields are `uri`, `place_action_type` and `is_preferred`. If the updated link already exists at the same location with the same `place_action_type` and `uri`, fails with an `ALREADY_EXISTS` error.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$PlaceActionLink;
}
export class Resource$Placeactiontypemetadata {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Returns the list of available place action types for a location or country.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/mybusinessplaceactions.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const mybusinessplaceactions = google.mybusinessplaceactions('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await mybusinessplaceactions.placeActionTypeMetadata.list({
* // Optional. A filter constraining the place action types to return metadata for. The response includes entries that match the filter. We support only the following filters: 1. location=XYZ where XYZ is a string indicating the resource name of a location, in the format `locations/{location_id\}`. 2. region_code=XYZ where XYZ is a Unicode CLDR region code to find available action types. If no filter is provided, all place action types are returned.
* filter: 'placeholder-value',
* // Optional. The IETF BCP-47 code of language to get display names in. If this language is not available, they will be provided in English.
* languageCode: 'placeholder-value',
* // Optional. How many action types to include per page. Default is 10, minimum is 1.
* pageSize: 'placeholder-value',
* // Optional. If specified, the next page of place action type metadata is retrieved. The `pageToken` is returned when a call to `placeActionTypeMetadata.list` returns more results than can fit into the requested page size.
* pageToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "placeActionTypeMetadata": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Placeactiontypemetadata$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Placeactiontypemetadata$List, options?: MethodOptions): GaxiosPromise<Schema$ListPlaceActionTypeMetadataResponse>;
list(params: Params$Resource$Placeactiontypemetadata$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Placeactiontypemetadata$List, options: MethodOptions | BodyResponseCallback<Schema$ListPlaceActionTypeMetadataResponse>, callback: BodyResponseCallback<Schema$ListPlaceActionTypeMetadataResponse>): void;
list(params: Params$Resource$Placeactiontypemetadata$List, callback: BodyResponseCallback<Schema$ListPlaceActionTypeMetadataResponse>): void;
list(callback: BodyResponseCallback<Schema$ListPlaceActionTypeMetadataResponse>): void;
}
export interface Params$Resource$Placeactiontypemetadata$List extends StandardParameters {
/**
* Optional. A filter constraining the place action types to return metadata for. The response includes entries that match the filter. We support only the following filters: 1. location=XYZ where XYZ is a string indicating the resource name of a location, in the format `locations/{location_id\}`. 2. region_code=XYZ where XYZ is a Unicode CLDR region code to find available action types. If no filter is provided, all place action types are returned.
*/
filter?: string;
/**
* Optional. The IETF BCP-47 code of language to get display names in. If this language is not available, they will be provided in English.
*/
languageCode?: string;
/**
* Optional. How many action types to include per page. Default is 10, minimum is 1.
*/
pageSize?: number;
/**
* Optional. If specified, the next page of place action type metadata is retrieved. The `pageToken` is returned when a call to `placeActionTypeMetadata.list` returns more results than can fit into the requested page size.
*/
pageToken?: string;
}
export {};
}