google_api_library_agent v0.4.2 GoogleApi.LibraryAgent.V1.Api.Shelves View Source

API calls for all endpoints tagged Shelves.

Link to this section Summary

Functions

Borrow a book from the library. Returns the book if it is borrowed successfully. Returns NOT_FOUND if the book does not exist in the library. Returns quota exceeded error if the amount of books borrowed exceeds allocation quota in any dimensions.

Gets a book. Returns NOT_FOUND if the book does not exist.

Lists books in a shelf. The order is unspecified but deterministic. Newly created books will not necessarily be added to the end of this list. Returns NOT_FOUND if the shelf does not exist.

Return a book to the library. Returns the book if it is returned to the library successfully. Returns error if the book does not belong to the library or the users didn't borrow before.

Gets a shelf. Returns NOT_FOUND if the shelf does not exist.

Lists shelves. The order is unspecified but deterministic. Newly created shelves will not necessarily be added to the end of this list.

Link to this section Functions

Link to this function

libraryagent_shelves_books_borrow(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

libraryagent_shelves_books_borrow(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.LibraryAgent.V1.Model.GoogleExampleLibraryagentV1Book.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Borrow a book from the library. Returns the book if it is borrowed successfully. Returns NOT_FOUND if the book does not exist in the library. Returns quota exceeded error if the amount of books borrowed exceeds allocation quota in any dimensions.

Parameters

  • connection (type: GoogleApi.LibraryAgent.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the book to borrow.
  • 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").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.LibraryAgent.V1.Model.GoogleExampleLibraryagentV1Book{}} on success
  • {:error, info} on failure
Link to this function

libraryagent_shelves_books_get(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

libraryagent_shelves_books_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.LibraryAgent.V1.Model.GoogleExampleLibraryagentV1Book.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Gets a book. Returns NOT_FOUND if the book does not exist.

Parameters

  • connection (type: GoogleApi.LibraryAgent.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the book 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").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.LibraryAgent.V1.Model.GoogleExampleLibraryagentV1Book{}} on success
  • {:error, info} on failure
Link to this function

libraryagent_shelves_books_list(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

libraryagent_shelves_books_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.LibraryAgent.V1.Model.GoogleExampleLibraryagentV1ListBooksResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Lists books in a shelf. The order is unspecified but deterministic. Newly created books will not necessarily be added to the end of this list. Returns NOT_FOUND if the shelf does not exist.

Parameters

  • connection (type: GoogleApi.LibraryAgent.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the shelf whose books we'd like to list.
  • 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").
    • :pageSize (type: integer()) - Requested page size. Server may return fewer books than requested. If unspecified, server will pick an appropriate default.
    • :pageToken (type: String.t) - A token identifying a page of results the server should return. Typically, this is the value of ListBooksResponse.next_page_token. returned from the previous call to ListBooks method.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.LibraryAgent.V1.Model.GoogleExampleLibraryagentV1ListBooksResponse{}} on success
  • {:error, info} on failure
Link to this function

libraryagent_shelves_books_return(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

libraryagent_shelves_books_return(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.LibraryAgent.V1.Model.GoogleExampleLibraryagentV1Book.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Return a book to the library. Returns the book if it is returned to the library successfully. Returns error if the book does not belong to the library or the users didn't borrow before.

Parameters

  • connection (type: GoogleApi.LibraryAgent.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the book to return.
  • 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").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.LibraryAgent.V1.Model.GoogleExampleLibraryagentV1Book{}} on success
  • {:error, info} on failure
Link to this function

libraryagent_shelves_get(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

libraryagent_shelves_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.LibraryAgent.V1.Model.GoogleExampleLibraryagentV1Shelf.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Gets a shelf. Returns NOT_FOUND if the shelf does not exist.

Parameters

  • connection (type: GoogleApi.LibraryAgent.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the shelf 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").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.LibraryAgent.V1.Model.GoogleExampleLibraryagentV1Shelf{}} on success
  • {:error, info} on failure
Link to this function

libraryagent_shelves_list(connection, optional_params \\ [], opts \\ [])

View Source

Specs

Lists shelves. The order is unspecified but deterministic. Newly created shelves will not necessarily be added to the end of this list.

Parameters

  • connection (type: GoogleApi.LibraryAgent.V1.Connection.t) - Connection to server
  • 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").
    • :pageSize (type: integer()) - Requested page size. Server may return fewer shelves than requested. If unspecified, server will pick an appropriate default.
    • :pageToken (type: String.t) - A token identifying a page of results the server should return. Typically, this is the value of ListShelvesResponse.next_page_token returned from the previous call to ListShelves method.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.LibraryAgent.V1.Model.GoogleExampleLibraryagentV1ListShelvesResponse{}} on success
  • {:error, info} on failure