Packages
Books API client library. The Google Books API allows clients to access the Google Books repository.
Current section
Files
Jump to
Current section
Files
lib/google_api/books/v1/api/cloudloading.ex
# Copyright 2017 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# NOTE: This class is auto generated by the swagger code generator program.
# https://github.com/swagger-api/swagger-codegen.git
# Do not edit the class manually.
defmodule GoogleApi.Books.V1.Api.Cloudloading do
@moduledoc """
API calls for all endpoints tagged `Cloudloading`.
"""
alias GoogleApi.Books.V1.Connection
import GoogleApi.Books.V1.RequestBuilder
@doc """
## Parameters
- connection (GoogleApi.Books.V1.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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 (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): 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. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
- :drive_document_id (String): A drive document id. The upload_client_token must not be set.
- :mime_type (String): The document MIME type. It can be set only if the drive_document_id is set.
- :name (String): The document name. It can be set only if the drive_document_id is set.
- :upload_client_token (String):
## Returns
{:ok, %GoogleApi.Books.V1.Model.BooksCloudloadingResource{}} on success
{:error, info} on failure
"""
@spec books_cloudloading_add_book(Tesla.Env.client, keyword()) :: {:ok, GoogleApi.Books.V1.Model.BooksCloudloadingResource.t} | {:error, Tesla.Env.t}
def books_cloudloading_add_book(connection, opts \\ []) do
optional_params = %{
:"alt" => :query,
:"fields" => :query,
:"key" => :query,
:"oauth_token" => :query,
:"prettyPrint" => :query,
:"quotaUser" => :query,
:"userIp" => :query,
:"drive_document_id" => :query,
:"mime_type" => :query,
:"name" => :query,
:"upload_client_token" => :query
}
%{}
|> method(:post)
|> url("/cloudloading/addBook")
|> add_optional_params(optional_params, opts)
|> Enum.into([])
|> (&Connection.request(connection, &1)).()
|> decode(%GoogleApi.Books.V1.Model.BooksCloudloadingResource{})
end
@doc """
Remove the book and its contents
## Parameters
- connection (GoogleApi.Books.V1.Connection): Connection to server
- volume_id (String): The id of the book to be removed.
- opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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 (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): 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. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
## Returns
{:ok, %{}} on success
{:error, info} on failure
"""
@spec books_cloudloading_delete_book(Tesla.Env.client, String.t, keyword()) :: {:ok, nil} | {:error, Tesla.Env.t}
def books_cloudloading_delete_book(connection, volume_id, opts \\ []) do
optional_params = %{
:"alt" => :query,
:"fields" => :query,
:"key" => :query,
:"oauth_token" => :query,
:"prettyPrint" => :query,
:"quotaUser" => :query,
:"userIp" => :query
}
%{}
|> method(:post)
|> url("/cloudloading/deleteBook")
|> add_param(:query, :"volumeId", volume_id)
|> add_optional_params(optional_params, opts)
|> Enum.into([])
|> (&Connection.request(connection, &1)).()
|> decode(false)
end
@doc """
## Parameters
- connection (GoogleApi.Books.V1.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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 (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): 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. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
- :body (BooksCloudloadingResource):
## Returns
{:ok, %GoogleApi.Books.V1.Model.BooksCloudloadingResource{}} on success
{:error, info} on failure
"""
@spec books_cloudloading_update_book(Tesla.Env.client, keyword()) :: {:ok, GoogleApi.Books.V1.Model.BooksCloudloadingResource.t} | {:error, Tesla.Env.t}
def books_cloudloading_update_book(connection, opts \\ []) do
optional_params = %{
:"alt" => :query,
:"fields" => :query,
:"key" => :query,
:"oauth_token" => :query,
:"prettyPrint" => :query,
:"quotaUser" => :query,
:"userIp" => :query,
:"body" => :body
}
%{}
|> method(:post)
|> url("/cloudloading/updateBook")
|> add_optional_params(optional_params, opts)
|> Enum.into([])
|> (&Connection.request(connection, &1)).()
|> decode(%GoogleApi.Books.V1.Model.BooksCloudloadingResource{})
end
end