Skip to content

Commit fa1520c

Browse files
gcf-owl-bot[bot]sofisl
gcf-owl-bot[bot]
and
sofisl
authored
fix: [Many APIs] fix typings for IAM methods (#4466)
* fix: fix typings for IAM methods docs: fixed links in the generated Markdown documentation PiperOrigin-RevId: 551610576 Source-Link: googleapis/googleapis@73b1313 Source-Link: googleapis/googleapis-gen@8bec066 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtYWRkcmVzc3ZhbGlkYXRpb24vLk93bEJvdC55YW1sIiwiaCI6IjhiZWMwNjY0OTJhNmRhMjg1NWIxYjhjZTU2MjY2NGMwYTZiMzBiMDEifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtbWFwc3BsYXRmb3JtZGF0YXNldHMvLk93bEJvdC55YW1sIiwiaCI6IjhiZWMwNjY0OTJhNmRhMjg1NWIxYjhjZTU2MjY2NGMwYTZiMzBiMDEifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtcGxhY2VzLy5Pd2xCb3QueWFtbCIsImgiOiI4YmVjMDY2NDkyYTZkYTI4NTViMWI4Y2U1NjI2NjRjMGE2YjMwYjAxIn0= Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtcm91dGluZy8uT3dsQm90LnlhbWwiLCJoIjoiOGJlYzA2NjQ5MmE2ZGEyODU1YjFiOGNlNTYyNjY0YzBhNmIzMGIwMSJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1vbml0b3JpbmctZGFzaGJvYXJkLy5Pd2xCb3QueWFtbCIsImgiOiI4YmVjMDY2NDkyYTZkYTI4NTViMWI4Y2U1NjI2NjRjMGE2YjMwYjAxIn0= Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLXByaXZhY3ktZGxwLy5Pd2xCb3QueWFtbCIsImgiOiI4YmVjMDY2NDkyYTZkYTI4NTViMWI4Y2U1NjI2NjRjMGE2YjMwYjAxIn0= Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLXN0b3JhZ2V0cmFuc2Zlci8uT3dsQm90LnlhbWwiLCJoIjoiOGJlYzA2NjQ5MmE2ZGEyODU1YjFiOGNlNTYyNjY0YzBhNmIzMGIwMSJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ3JhZmVhcy8uT3dsQm90LnlhbWwiLCJoIjoiOGJlYzA2NjQ5MmE2ZGEyODU1YjFiOGNlNTYyNjY0YzBhNmIzMGIwMSJ9 * 🦉 Updates from OwlBot post-processor * chore!: update to Node 14 See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: sofisl <[email protected]>
1 parent 64109b0 commit fa1520c

33 files changed

Lines changed: 4504 additions & 512 deletions

‎packages/google-maps-addressvalidation/README.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
[//]: # "To regenerate it, use `python -m synthtool`."
33
<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
44

5-
# [Address Validation API: Node.js Client](https://github.com/googleapis/google-cloud-node)
5+
# [Address Validation API: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-maps-addressvalidation)
66

77
[![release level](https://img.shields.io/badge/release%20level-stable-brightgreen.svg?style=flat)](https://cloud.google.com/terms/launch-stages)
88
[![npm version](https://img.shields.io/npm/v/@googlemaps/addressvalidation.svg)](https://www.npmjs.org/package/@googlemaps/addressvalidation)
@@ -106,6 +106,7 @@ npm install @googlemaps/addressvalidation
106106
// const enableUspsCass = true
107107

108108
// Imports the Addressvalidation library
109+
// eslint-disable-next-line node/no-missing-require
109110
const {AddressValidationClient} = require('@googlemaps/addressvalidation').v1;
110111

111112
// Instantiates a client
@@ -133,14 +134,13 @@ callValidateAddress();
133134

134135
## Samples
135136

136-
Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/samples) directory. Each sample's `README.md` has instructions for running its sample.
137+
Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-maps-addressvalidation/samples) directory. Each sample's `README.md` has instructions for running its sample.
137138

138139
| Sample | Source Code | Try it |
139140
| --------------------------- | --------------------------------- | ------ |
140-
| Address_validation.provide_validation_feedback | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-addressvalidation/samples/generated/v1/address_validation.provide_validation_feedback.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-addressvalidation/samples/generated/v1/address_validation.provide_validation_feedback.js,samples/README.md) |
141-
| Address_validation.validate_address | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-addressvalidation/samples/generated/v1/address_validation.validate_address.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-addressvalidation/samples/generated/v1/address_validation.validate_address.js,samples/README.md) |
142-
| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-addressvalidation/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-addressvalidation/samples/quickstart.js,samples/README.md) |
143-
| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-addressvalidation/samples/test/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-addressvalidation/samples/test/quickstart.js,samples/README.md) |
141+
| Address_validation.provide_validation_feedback | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-addressvalidation/samples/generated/v1/address_validation.provide_validation_feedback.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-addressvalidation/samples/generated/v1/address_validation.provide_validation_feedback.js,packages/google-maps-addressvalidation/samples/README.md) |
142+
| Address_validation.validate_address | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-addressvalidation/samples/generated/v1/address_validation.validate_address.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-addressvalidation/samples/generated/v1/address_validation.validate_address.js,packages/google-maps-addressvalidation/samples/README.md) |
143+
| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-addressvalidation/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-addressvalidation/samples/quickstart.js,packages/google-maps-addressvalidation/samples/README.md) |
144144

145145

146146

‎packages/google-maps-addressvalidation/samples/README.md‎

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
* [Address_validation.provide_validation_feedback](#address_validation.provide_validation_feedback)
1616
* [Address_validation.validate_address](#address_validation.validate_address)
1717
* [Quickstart](#quickstart)
18-
* [Quickstart](#quickstart)
1918

2019
## Before you begin
2120

@@ -78,23 +77,6 @@ __Usage:__
7877
`node packages/google-maps-addressvalidation/samples/quickstart.js`
7978

8079

81-
-----
82-
83-
84-
85-
86-
### Quickstart
87-
88-
View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-addressvalidation/samples/test/quickstart.js).
89-
90-
[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-addressvalidation/samples/test/quickstart.js,samples/README.md)
91-
92-
__Usage:__
93-
94-
95-
`node packages/google-maps-addressvalidation/samples/test/quickstart.js`
96-
97-
9880

9981

10082

‎packages/google-maps-addressvalidation/samples/generated/v1/snippet_metadata_google.maps.addressvalidation.v1.json‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
{
2+
"clientLibrary": {
3+
"name": "nodejs-addressvalidation",
4+
"version": "1.0.2",
5+
"language": "TYPESCRIPT",
6+
"apis": [
7+
{
8+
"id": "google.maps.addressvalidation.v1",
9+
"version": "v1"
10+
}
11+
]
12+
},
13+
"snippets": [
14+
{
15+
"regionTag": "addressvalidation_v1_generated_AddressValidation_ValidateAddress_async",
16+
"title": "AddressValidation validateAddress Sample",
17+
"origin": "API_DEFINITION",
18+
"description": " Validates an address.",
19+
"canonical": true,
20+
"file": "address_validation.validate_address.js",
21+
"language": "JAVASCRIPT",
22+
"segments": [
23+
{
24+
"start": 25,
25+
"end": 90,
26+
"type": "FULL"
27+
}
28+
],
29+
"clientMethod": {
30+
"shortName": "ValidateAddress",
31+
"fullName": "google.maps.addressvalidation.v1.AddressValidation.ValidateAddress",
32+
"async": true,
33+
"parameters": [
34+
{
35+
"name": "address",
36+
"type": ".google.type.PostalAddress"
37+
},
38+
{
39+
"name": "previous_response_id",
40+
"type": "TYPE_STRING"
41+
},
42+
{
43+
"name": "enable_usps_cass",
44+
"type": "TYPE_BOOL"
45+
}
46+
],
47+
"resultType": ".google.maps.addressvalidation.v1.ValidateAddressResponse",
48+
"client": {
49+
"shortName": "AddressValidationClient",
50+
"fullName": "google.maps.addressvalidation.v1.AddressValidationClient"
51+
},
52+
"method": {
53+
"shortName": "ValidateAddress",
54+
"fullName": "google.maps.addressvalidation.v1.AddressValidation.ValidateAddress",
55+
"service": {
56+
"shortName": "AddressValidation",
57+
"fullName": "google.maps.addressvalidation.v1.AddressValidation"
58+
}
59+
}
60+
}
61+
},
62+
{
63+
"regionTag": "addressvalidation_v1_generated_AddressValidation_ProvideValidationFeedback_async",
64+
"title": "AddressValidation provideValidationFeedback Sample",
65+
"origin": "API_DEFINITION",
66+
"description": " Feedback about the outcome of the sequence of validation attempts. This should be the last call made after a sequence of validation calls for the same address, and should be called once the transaction is concluded. This should only be sent once for the sequence of `ValidateAddress` requests needed to validate an address fully.",
67+
"canonical": true,
68+
"file": "address_validation.provide_validation_feedback.js",
69+
"language": "JAVASCRIPT",
70+
"segments": [
71+
{
72+
"start": 25,
73+
"end": 63,
74+
"type": "FULL"
75+
}
76+
],
77+
"clientMethod": {
78+
"shortName": "ProvideValidationFeedback",
79+
"fullName": "google.maps.addressvalidation.v1.AddressValidation.ProvideValidationFeedback",
80+
"async": true,
81+
"parameters": [
82+
{
83+
"name": "conclusion",
84+
"type": ".google.maps.addressvalidation.v1.ProvideValidationFeedbackRequest.ValidationConclusion"
85+
},
86+
{
87+
"name": "response_id",
88+
"type": "TYPE_STRING"
89+
}
90+
],
91+
"resultType": ".google.maps.addressvalidation.v1.ProvideValidationFeedbackResponse",
92+
"client": {
93+
"shortName": "AddressValidationClient",
94+
"fullName": "google.maps.addressvalidation.v1.AddressValidationClient"
95+
},
96+
"method": {
97+
"shortName": "ProvideValidationFeedback",
98+
"fullName": "google.maps.addressvalidation.v1.AddressValidation.ProvideValidationFeedback",
99+
"service": {
100+
"shortName": "AddressValidation",
101+
"fullName": "google.maps.addressvalidation.v1.AddressValidation"
102+
}
103+
}
104+
}
105+
}
106+
]
107+
}

‎packages/google-maps-addressvalidation/src/v1/address_validation_client.ts‎

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -314,30 +314,30 @@ export class AddressValidationClient {
314314
* The request object that will be sent.
315315
* @param {google.type.PostalAddress} request.address
316316
* Required. The address being validated. Unformatted addresses should be
317-
* submitted via {@link google.type.PostalAddress.address_lines|`address_lines`}.
317+
* submitted via {@link protos.google.type.PostalAddress.address_lines|`address_lines`}.
318318
*
319319
* The total length of the fields in this input must not exceed 280
320320
* characters.
321321
*
322322
* Supported regions can be found in the
323323
* [FAQ](https://developers.google.com/maps/documentation/address-validation/faq#which_regions_are_currently_supported).
324324
*
325-
* The {@link google.type.PostalAddress.language_code|language_code} value in the
325+
* The {@link protos.google.type.PostalAddress.language_code|language_code} value in the
326326
* input address is reserved for future uses and is ignored today. The
327327
* validated address result will be populated based on the preferred language
328328
* for the given address, as identified by the system.
329329
*
330330
* The Address Validation API ignores the values in
331-
* {@link google.type.PostalAddress.recipients|recipients} and
332-
* {@link google.type.PostalAddress.organization|organization}. Any values in those
331+
* {@link protos.google.type.PostalAddress.recipients|recipients} and
332+
* {@link protos.google.type.PostalAddress.organization|organization}. Any values in those
333333
* fields will be discarded and not returned. Please do not set them.
334334
* @param {string} request.previousResponseId
335335
* This field must be empty for the first address validation request. If
336336
* more requests are necessary to fully validate a single address (for
337337
* example if the changes the user makes after the initial validation need to
338338
* be re-validated), then each followup request must populate this field with
339339
* the
340-
* {@link google.maps.addressvalidation.v1.ValidateAddressResponse.response_id|response_id}
340+
* {@link protos.google.maps.addressvalidation.v1.ValidateAddressResponse.response_id|response_id}
341341
* from the very first response in the validation sequence.
342342
* @param {boolean} request.enableUspsCass
343343
* Enables USPS CASS compatible mode. This affects _only_ the
@@ -355,9 +355,8 @@ export class AddressValidationClient {
355355
* @param {object} [options]
356356
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
357357
* @returns {Promise} - The promise which resolves to an array.
358-
* The first element of the array is an object representing {@link google.maps.addressvalidation.v1.ValidateAddressResponse | ValidateAddressResponse}.
359-
* Please see the
360-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
358+
* The first element of the array is an object representing {@link protos.google.maps.addressvalidation.v1.ValidateAddressResponse|ValidateAddressResponse}.
359+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
361360
* for more details and examples.
362361
* @example <caption>include:samples/generated/v1/address_validation.validate_address.js</caption>
363362
* region_tag:addressvalidation_v1_generated_AddressValidation_ValidateAddress_async
@@ -455,14 +454,13 @@ export class AddressValidationClient {
455454
* @param {string} request.responseId
456455
* Required. The ID of the response that this feedback is for. This should be
457456
* the
458-
* {@link google.maps.addressvalidation.v1.ValidateAddressRequest.response_id|response_id}
457+
* {@link protos.google.maps.addressvalidation.v1.ValidateAddressRequest.response_id|response_id}
459458
* from the first response in a series of address validation attempts.
460459
* @param {object} [options]
461460
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
462461
* @returns {Promise} - The promise which resolves to an array.
463-
* The first element of the array is an object representing {@link google.maps.addressvalidation.v1.ProvideValidationFeedbackResponse | ProvideValidationFeedbackResponse}.
464-
* Please see the
465-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
462+
* The first element of the array is an object representing {@link protos.google.maps.addressvalidation.v1.ProvideValidationFeedbackResponse|ProvideValidationFeedbackResponse}.
463+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
466464
* for more details and examples.
467465
* @example <caption>include:samples/generated/v1/address_validation.provide_validation_feedback.js</caption>
468466
* region_tag:addressvalidation_v1_generated_AddressValidation_ProvideValidationFeedback_async

0 commit comments

Comments
 (0)