google_api_books v0.8.0 GoogleApi.Books.V1.Api.Bookshelves View Source

API calls for all endpoints tagged Bookshelves.

Link to this section Summary

Functions

Retrieves metadata for a specific bookshelf for the specified user.

Retrieves a list of public bookshelves for the specified user.

Retrieves volumes in a specific bookshelf for the specified user.

Link to this section Functions

Link to this function

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

View Source
books_bookshelves_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, GoogleApi.Books.V1.Model.Bookshelf.t()} | {:error, Tesla.Env.t()}

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

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :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
Link to this function

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

View Source
books_bookshelves_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Books.V1.Model.Bookshelves.t()} | {:error, Tesla.Env.t()}

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

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :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
Link to this function

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

View Source
books_bookshelves_volumes_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, GoogleApi.Books.V1.Model.Volumes.t()} | {:error, Tesla.Env.t()}

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

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :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