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

API calls for all endpoints tagged Onboarding.

Summary

Functions

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

List categories for onboarding experience.

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

List available volumes under categories for onboarding experience.

Functions

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

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

List categories for onboarding experience.

Parameters

connection (type: GoogleApi.Books.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").
- :locale (type: String.t) - ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.
opts (type: keyword()) - Call options

Returns

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

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

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

List available volumes under categories for onboarding experience.

Parameters

connection (type: GoogleApi.Books.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").
- :categoryId (type: list(String.t)) - List of category ids requested.
- :locale (type: String.t) - ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.
- :maxAllowedMaturityRating (type: String.t) - The maximum allowed maturity rating of returned volumes. Books with a higher maturity rating are filtered out.
- :pageSize (type: integer()) - Number of maximum results per page to be included in the response.
- :pageToken (type: String.t) - The value of the nextToken from the previous page.
opts (type: keyword()) - Call options

Returns

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