blob: 37f5d9c2cb376ef95baf6cbce3d452fb636600aa [file] [log] [blame]
yoshi-code-bot8bb904c2021-08-31 00:28:27 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="mybusinessverifications_v1.html">My Business Verifications API</a> . <a href="mybusinessverifications_v1.locations.html">locations</a> . <a href="mybusinessverifications_v1.locations.verifications.html">verifications</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81 <code><a href="#complete">complete(name, body=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Completes a `PENDING` verification. It is only necessary for non `AUTO` verification methods. `AUTO` verification request is instantly `VERIFIED` upon creation.</p>
83<p class="toc_element">
84 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
85<p class="firstline">List verifications of a location, ordered by create time.</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
96 <code class="details" id="complete">complete(name, body=None, x__xgafv=None)</code>
97 <pre>Completes a `PENDING` verification. It is only necessary for non `AUTO` verification methods. `AUTO` verification request is instantly `VERIFIED` upon creation.
98
99Args:
100 name: string, Required. Resource name of the verification to complete. (required)
101 body: object, The request body.
102 The object takes the form of:
103
104{ # Request message for Verifications.CompleteVerificationAction.
105 &quot;pin&quot;: &quot;A String&quot;, # Required. PIN code received by the merchant to complete the verification.
106}
107
108 x__xgafv: string, V1 error format.
109 Allowed values
110 1 - v1 error format
111 2 - v2 error format
112
113Returns:
114 An object of the form:
115
116 { # Response message for Verifications.CompleteVerificationAction.
117 &quot;verification&quot;: { # A verification represents a verification attempt on a location. # The completed verification.
118 &quot;createTime&quot;: &quot;A String&quot;, # The timestamp when the verification is requested.
119 &quot;method&quot;: &quot;A String&quot;, # The method of the verification.
120 &quot;name&quot;: &quot;A String&quot;, # Resource name of the verification.
121 &quot;state&quot;: &quot;A String&quot;, # The state of the verification.
122 },
123}</pre>
124</div>
125
126<div class="method">
127 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
128 <pre>List verifications of a location, ordered by create time.
129
130Args:
131 parent: string, Required. Resource name of the location that verification requests belong to. (required)
132 pageSize: integer, How many verification to include per page. Minimum is 1, and the default and maximum page size is 100.
133 pageToken: string, If specified, returns the next page of verifications.
134 x__xgafv: string, V1 error format.
135 Allowed values
136 1 - v1 error format
137 2 - v2 error format
138
139Returns:
140 An object of the form:
141
142 { # Response message for Verifications.ListVerifications.
143 &quot;nextPageToken&quot;: &quot;A String&quot;, # If the number of verifications exceeded the requested page size, this field will be populated with a token to fetch the next page of verification on a subsequent call. If there are no more attributes, this field will not be present in the response.
144 &quot;verifications&quot;: [ # List of the verifications.
145 { # A verification represents a verification attempt on a location.
146 &quot;createTime&quot;: &quot;A String&quot;, # The timestamp when the verification is requested.
147 &quot;method&quot;: &quot;A String&quot;, # The method of the verification.
148 &quot;name&quot;: &quot;A String&quot;, # Resource name of the verification.
149 &quot;state&quot;: &quot;A String&quot;, # The state of the verification.
150 },
151 ],
152}</pre>
153</div>
154
155<div class="method">
156 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
157 <pre>Retrieves the next page of results.
158
159Args:
160 previous_request: The request for the previous page. (required)
161 previous_response: The response from the request for the previous page. (required)
162
163Returns:
164 A request object that you can call &#x27;execute()&#x27; on to request the next
165 page. Returns None if there are no more items in the collection.
166 </pre>
167</div>
168
169</body></html>