blob: 37f5d9c2cb376ef95baf6cbce3d452fb636600aa [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<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>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#complete">complete(name, body=None, x__xgafv=None)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List verifications of a location, ordered by create time.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="complete">complete(name, body=None, x__xgafv=None)</code>
<pre>Completes a `PENDING` verification. It is only necessary for non `AUTO` verification methods. `AUTO` verification request is instantly `VERIFIED` upon creation.
Args:
name: string, Required. Resource name of the verification to complete. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for Verifications.CompleteVerificationAction.
&quot;pin&quot;: &quot;A String&quot;, # Required. PIN code received by the merchant to complete the verification.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for Verifications.CompleteVerificationAction.
&quot;verification&quot;: { # A verification represents a verification attempt on a location. # The completed verification.
&quot;createTime&quot;: &quot;A String&quot;, # The timestamp when the verification is requested.
&quot;method&quot;: &quot;A String&quot;, # The method of the verification.
&quot;name&quot;: &quot;A String&quot;, # Resource name of the verification.
&quot;state&quot;: &quot;A String&quot;, # The state of the verification.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List verifications of a location, ordered by create time.
Args:
parent: string, Required. Resource name of the location that verification requests belong to. (required)
pageSize: integer, How many verification to include per page. Minimum is 1, and the default and maximum page size is 100.
pageToken: string, If specified, returns the next page of verifications.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for Verifications.ListVerifications.
&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.
&quot;verifications&quot;: [ # List of the verifications.
{ # A verification represents a verification attempt on a location.
&quot;createTime&quot;: &quot;A String&quot;, # The timestamp when the verification is requested.
&quot;method&quot;: &quot;A String&quot;, # The method of the verification.
&quot;name&quot;: &quot;A String&quot;, # Resource name of the verification.
&quot;state&quot;: &quot;A String&quot;, # The state of the verification.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>