Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
See: Library Agent API Reference for libraryagent.shelves.books.list
.
Synopsis
- type ShelvesBooksListResource = "v1" :> (Capture "parent" Text :> ("books" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] GoogleExampleLibraryagentV1ListBooksResponse))))))))))
- shelvesBooksList :: Text -> ShelvesBooksList
- data ShelvesBooksList
- sblParent :: Lens' ShelvesBooksList Text
- sblXgafv :: Lens' ShelvesBooksList (Maybe Xgafv)
- sblUploadProtocol :: Lens' ShelvesBooksList (Maybe Text)
- sblAccessToken :: Lens' ShelvesBooksList (Maybe Text)
- sblUploadType :: Lens' ShelvesBooksList (Maybe Text)
- sblPageToken :: Lens' ShelvesBooksList (Maybe Text)
- sblPageSize :: Lens' ShelvesBooksList (Maybe Int32)
- sblCallback :: Lens' ShelvesBooksList (Maybe Text)
REST Resource
type ShelvesBooksListResource = "v1" :> (Capture "parent" Text :> ("books" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] GoogleExampleLibraryagentV1ListBooksResponse)))))))))) Source #
A resource alias for libraryagent.shelves.books.list
method which the
ShelvesBooksList
request conforms to.
Creating a Request
Creates a value of ShelvesBooksList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ShelvesBooksList Source #
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.
See: shelvesBooksList
smart constructor.
Instances
Request Lenses
sblParent :: Lens' ShelvesBooksList Text Source #
The name of the shelf whose books we'd like to list.
sblUploadProtocol :: Lens' ShelvesBooksList (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
sblAccessToken :: Lens' ShelvesBooksList (Maybe Text) Source #
OAuth access token.
sblUploadType :: Lens' ShelvesBooksList (Maybe Text) Source #
Legacy upload protocol for media (e.g. "media", "multipart").
sblPageToken :: Lens' ShelvesBooksList (Maybe Text) Source #
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.
sblPageSize :: Lens' ShelvesBooksList (Maybe Int32) Source #
Requested page size. Server may return fewer books than requested. If unspecified, server will pick an appropriate default.
sblCallback :: Lens' ShelvesBooksList (Maybe Text) Source #
JSONP