| Copyright | (c) 2015 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 |
Network.Google.Resource.Books.Onboarding.ListCategoryVolumes
Description
List available volumes under categories for onboarding experience.
See: Books API Reference for books.onboarding.listCategoryVolumes.
- type OnboardingListCategoryVolumesResource = "books" :> ("v1" :> ("onboarding" :> ("listCategoryVolumes" :> (QueryParam "locale" Text :> (QueryParam "maxAllowedMaturityRating" OnboardingListCategoryVolumesMaxAllowedMaturityRating :> (QueryParams "categoryId" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` Volume2)))))))))
- onboardingListCategoryVolumes :: OnboardingListCategoryVolumes
- data OnboardingListCategoryVolumes
- olcvLocale :: Lens' OnboardingListCategoryVolumes (Maybe Text)
- olcvMaxAllowedMaturityRating :: Lens' OnboardingListCategoryVolumes (Maybe OnboardingListCategoryVolumesMaxAllowedMaturityRating)
- olcvCategoryId :: Lens' OnboardingListCategoryVolumes [Text]
- olcvPageToken :: Lens' OnboardingListCategoryVolumes (Maybe Text)
- olcvPageSize :: Lens' OnboardingListCategoryVolumes (Maybe Word32)
REST Resource
type OnboardingListCategoryVolumesResource = "books" :> ("v1" :> ("onboarding" :> ("listCategoryVolumes" :> (QueryParam "locale" Text :> (QueryParam "maxAllowedMaturityRating" OnboardingListCategoryVolumesMaxAllowedMaturityRating :> (QueryParams "categoryId" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` Volume2))))))))) Source
A resource alias for books.onboarding.listCategoryVolumes method which the
OnboardingListCategoryVolumes request conforms to.
Creating a Request
onboardingListCategoryVolumes :: OnboardingListCategoryVolumes Source
Creates a value of OnboardingListCategoryVolumes with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data OnboardingListCategoryVolumes Source
List available volumes under categories for onboarding experience.
See: onboardingListCategoryVolumes smart constructor.
Instances
Request Lenses
olcvLocale :: Lens' OnboardingListCategoryVolumes (Maybe Text) Source
ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.
olcvMaxAllowedMaturityRating :: Lens' OnboardingListCategoryVolumes (Maybe OnboardingListCategoryVolumesMaxAllowedMaturityRating) Source
The maximum allowed maturity rating of returned volumes. Books with a higher maturity rating are filtered out.
olcvCategoryId :: Lens' OnboardingListCategoryVolumes [Text] Source
List of category ids requested.
olcvPageToken :: Lens' OnboardingListCategoryVolumes (Maybe Text) Source
The value of the nextToken from the previous page.
olcvPageSize :: Lens' OnboardingListCategoryVolumes (Maybe Word32) Source
Number of maximum results per page to be included in the response.