View Source GoogleApi.Books.V1.Api.Bookshelves (google_api_books v0.21.0)

API calls for all endpoints tagged Bookshelves.

Summary

Functions

books_bookshelves_get(connection, user_id, shelf, optional_params \\ [], opts \\ [])

Retrieves metadata for a specific bookshelf for the specified user.

books_bookshelves_list(connection, user_id, optional_params \\ [], opts \\ [])

Retrieves a list of public bookshelves for the specified user.

books_bookshelves_volumes_list(connection, user_id, shelf, optional_params \\ [], opts \\ [])

Retrieves volumes in a specific bookshelf for the specified user.

Functions

books_bookshelves_get(connection, user_id, shelf, optional_params \\ [], opts \\ [])

@spec books_bookshelves_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Books.V1.Model.Bookshelf.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves metadata for a specific bookshelf for the specified user.

Parameters

connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
user_id (type: String.t) - ID of user for whom to retrieve bookshelves.
shelf (type: String.t) - ID of bookshelf to retrieve.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - 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.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :source (type: String.t) - String to identify the originator of this request.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Books.V1.Model.Bookshelf{}} on success
{:error, info} on failure

books_bookshelves_list(connection, user_id, optional_params \\ [], opts \\ [])

@spec books_bookshelves_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Books.V1.Model.Bookshelves.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves a list of public bookshelves for the specified user.

Parameters

connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
user_id (type: String.t) - ID of user for whom to retrieve bookshelves.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - 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.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :source (type: String.t) - String to identify the originator of this request.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Books.V1.Model.Bookshelves{}} on success
{:error, info} on failure

books_bookshelves_volumes_list(connection, user_id, shelf, optional_params \\ [], opts \\ [])

@spec books_bookshelves_volumes_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Books.V1.Model.Volumes.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves volumes in a specific bookshelf for the specified user.

Parameters

connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
user_id (type: String.t) - ID of user for whom to retrieve bookshelf volumes.
shelf (type: String.t) - ID of bookshelf to retrieve volumes.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - 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.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :maxResults (type: integer()) - Maximum number of results to return
- :showPreorders (type: boolean()) - Set to true to show pre-ordered books. Defaults to false.
- :source (type: String.t) - String to identify the originator of this request.
- :startIndex (type: integer()) - Index of the first element to return (starts at 0)
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Books.V1.Model.Volumes{}} on success
{:error, info} on failure