blob: f9e3adc139b9ca10f2a8d2f37e4087f886340223 [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="books_v1.html">Books API</a> . <a href="books_v1.mylibrary.html">mylibrary</a> . <a href="books_v1.mylibrary.bookshelves.html">bookshelves</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="books_v1.mylibrary.bookshelves.volumes.html">volumes()</a></code>
</p>
<p class="firstline">Returns the volumes Resource.</p>
<p class="toc_element">
<code><a href="#addVolume">addVolume(shelf, volumeId, reason=None, source=None, x__xgafv=None)</a></code></p>
<p class="firstline">Adds a volume to a bookshelf.</p>
<p class="toc_element">
<code><a href="#clearVolumes">clearVolumes(shelf, source=None, x__xgafv=None)</a></code></p>
<p class="firstline">Clears all volumes from a bookshelf.</p>
<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="#get">get(shelf, source=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves metadata for a specific bookshelf belonging to the authenticated user.</p>
<p class="toc_element">
<code><a href="#list">list(source=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of bookshelves belonging to the authenticated user.</p>
<p class="toc_element">
<code><a href="#moveVolume">moveVolume(shelf, volumeId, volumePosition, source=None, x__xgafv=None)</a></code></p>
<p class="firstline">Moves a volume within a bookshelf.</p>
<p class="toc_element">
<code><a href="#removeVolume">removeVolume(shelf, volumeId, reason=None, source=None, x__xgafv=None)</a></code></p>
<p class="firstline">Removes a volume from a bookshelf.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="addVolume">addVolume(shelf, volumeId, reason=None, source=None, x__xgafv=None)</code>
<pre>Adds a volume to a bookshelf.
Args:
shelf: string, ID of bookshelf to which to add a volume. (required)
volumeId: string, ID of volume to add. (required)
reason: string, The reason for which the book is added to the library.
Allowed values
REASON_UNDEFINED -
IOS_PREX - Volumes added from the PREX flow on iOS.
IOS_SEARCH - Volumes added from the Search flow on iOS.
ONBOARDING - Volumes added from the Onboarding flow.
source: string, String to identify the originator of this request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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 `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="clearVolumes">clearVolumes(shelf, source=None, x__xgafv=None)</code>
<pre>Clears all volumes from a bookshelf.
Args:
shelf: string, ID of bookshelf from which to remove a volume. (required)
source: string, String to identify the originator of this request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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 `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(shelf, source=None, x__xgafv=None)</code>
<pre>Retrieves metadata for a specific bookshelf belonging to the authenticated user.
Args:
shelf: string, ID of bookshelf to retrieve. (required)
source: string, String to identify the originator of this request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
&quot;access&quot;: &quot;A String&quot;, # Whether this bookshelf is PUBLIC or PRIVATE.
&quot;created&quot;: &quot;A String&quot;, # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
&quot;description&quot;: &quot;A String&quot;, # Description of this bookshelf.
&quot;id&quot;: 42, # Id of this bookshelf, only unique by user.
&quot;kind&quot;: &quot;A String&quot;, # Resource type for bookshelf metadata.
&quot;selfLink&quot;: &quot;A String&quot;, # URL to this resource.
&quot;title&quot;: &quot;A String&quot;, # Title of this bookshelf.
&quot;updated&quot;: &quot;A String&quot;, # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
&quot;volumeCount&quot;: 42, # Number of volumes in this bookshelf.
&quot;volumesLastUpdated&quot;: &quot;A String&quot;, # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(source=None, x__xgafv=None)</code>
<pre>Retrieves a list of bookshelves belonging to the authenticated user.
Args:
source: string, String to identify the originator of this request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
&quot;items&quot;: [ # A list of bookshelves.
{
&quot;access&quot;: &quot;A String&quot;, # Whether this bookshelf is PUBLIC or PRIVATE.
&quot;created&quot;: &quot;A String&quot;, # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
&quot;description&quot;: &quot;A String&quot;, # Description of this bookshelf.
&quot;id&quot;: 42, # Id of this bookshelf, only unique by user.
&quot;kind&quot;: &quot;A String&quot;, # Resource type for bookshelf metadata.
&quot;selfLink&quot;: &quot;A String&quot;, # URL to this resource.
&quot;title&quot;: &quot;A String&quot;, # Title of this bookshelf.
&quot;updated&quot;: &quot;A String&quot;, # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
&quot;volumeCount&quot;: 42, # Number of volumes in this bookshelf.
&quot;volumesLastUpdated&quot;: &quot;A String&quot;, # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
},
],
&quot;kind&quot;: &quot;A String&quot;, # Resource type.
}</pre>
</div>
<div class="method">
<code class="details" id="moveVolume">moveVolume(shelf, volumeId, volumePosition, source=None, x__xgafv=None)</code>
<pre>Moves a volume within a bookshelf.
Args:
shelf: string, ID of bookshelf with the volume. (required)
volumeId: string, ID of volume to move. (required)
volumePosition: integer, Position on shelf to move the item (0 puts the item before the current first item, 1 puts it between the first and the second and so on.) (required)
source: string, String to identify the originator of this request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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 `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="removeVolume">removeVolume(shelf, volumeId, reason=None, source=None, x__xgafv=None)</code>
<pre>Removes a volume from a bookshelf.
Args:
shelf: string, ID of bookshelf from which to remove a volume. (required)
volumeId: string, ID of volume to remove. (required)
reason: string, The reason for which the book is removed from the library.
Allowed values
REASON_UNDEFINED -
ONBOARDING - Samples removed from the Onboarding flow.
source: string, String to identify the originator of this request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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 `{}`.
}</pre>
</div>
</body></html>