Network.Google.Resource.Books.Onboarding.ListCategoryVolumes

List available volumes under categories for onboarding experience.

See: Books API Reference for books.onboarding.listCategoryVolumes.

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)))))))))

A resource alias for books.onboarding.listCategoryVolumes method which the OnboardingListCategoryVolumes request conforms to.

Creating a Request

onboardingListCategoryVolumes :: OnboardingListCategoryVolumes

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:

• olcvLocale
• olcvMaxAllowedMaturityRating
• olcvCategoryId
• olcvPageToken
• olcvPageSize

data OnboardingListCategoryVolumes

List available volumes under categories for onboarding experience.

See: onboardingListCategoryVolumes smart constructor.

Instances

Eq OnboardingListCategoryVolumes

Defined in Network.Google.Resource.Books.Onboarding.ListCategoryVolumes

Methods

(==) :: OnboardingListCategoryVolumes -> OnboardingListCategoryVolumes -> Bool

(/=) :: OnboardingListCategoryVolumes -> OnboardingListCategoryVolumes -> Bool

Data OnboardingListCategoryVolumes

Defined in Network.Google.Resource.Books.Onboarding.ListCategoryVolumes

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OnboardingListCategoryVolumes -> c OnboardingListCategoryVolumes

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OnboardingListCategoryVolumes

toConstr :: OnboardingListCategoryVolumes -> Constr

dataTypeOf :: OnboardingListCategoryVolumes -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c OnboardingListCategoryVolumes)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OnboardingListCategoryVolumes)

gmapT :: (forall b. Data b => b -> b) -> OnboardingListCategoryVolumes -> OnboardingListCategoryVolumes

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OnboardingListCategoryVolumes -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OnboardingListCategoryVolumes -> r

gmapQ :: (forall d. Data d => d -> u) -> OnboardingListCategoryVolumes -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> OnboardingListCategoryVolumes -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> OnboardingListCategoryVolumes -> m OnboardingListCategoryVolumes

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OnboardingListCategoryVolumes -> m OnboardingListCategoryVolumes

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OnboardingListCategoryVolumes -> m OnboardingListCategoryVolumes

Show OnboardingListCategoryVolumes

Defined in Network.Google.Resource.Books.Onboarding.ListCategoryVolumes

Methods

showsPrec :: Int -> OnboardingListCategoryVolumes -> ShowS

show :: OnboardingListCategoryVolumes -> String

showList :: [OnboardingListCategoryVolumes] -> ShowS

Generic OnboardingListCategoryVolumes

Defined in Network.Google.Resource.Books.Onboarding.ListCategoryVolumes

Associated Types

type Rep OnboardingListCategoryVolumes :: Type -> Type

Methods

from :: OnboardingListCategoryVolumes -> Rep OnboardingListCategoryVolumes x

to :: Rep OnboardingListCategoryVolumes x -> OnboardingListCategoryVolumes

GoogleRequest OnboardingListCategoryVolumes

Defined in Network.Google.Resource.Books.Onboarding.ListCategoryVolumes

Associated Types

type Rs OnboardingListCategoryVolumes :: Type

type Scopes OnboardingListCategoryVolumes :: [Symbol]

Methods

requestClient :: OnboardingListCategoryVolumes -> GClient (Rs OnboardingListCategoryVolumes)

type Rep OnboardingListCategoryVolumes

Defined in Network.Google.Resource.Books.Onboarding.ListCategoryVolumes

type Rep OnboardingListCategoryVolumes = D1 (MetaData "OnboardingListCategoryVolumes" "Network.Google.Resource.Books.Onboarding.ListCategoryVolumes" "gogol-books-0.4.0-JsYtirrXlXLDWYQKuxGcRl" False) (C1 (MetaCons "OnboardingListCategoryVolumes'" PrefixI True) ((S1 (MetaSel (Just "_olcvLocale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_olcvMaxAllowedMaturityRating") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe OnboardingListCategoryVolumesMaxAllowedMaturityRating))) :*: (S1 (MetaSel (Just "_olcvCategoryId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 (MetaSel (Just "_olcvPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_olcvPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32)))))))

type Scopes OnboardingListCategoryVolumes

Defined in Network.Google.Resource.Books.Onboarding.ListCategoryVolumes

type Scopes OnboardingListCategoryVolumes = "https://www.googleapis.com/auth/books" ': ([] :: [Symbol])

type Rs OnboardingListCategoryVolumes

Defined in Network.Google.Resource.Books.Onboarding.ListCategoryVolumes

type Rs OnboardingListCategoryVolumes = Volume2

Request Lenses

olcvLocale :: Lens' OnboardingListCategoryVolumes (Maybe Text)

ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.

olcvMaxAllowedMaturityRating :: Lens' OnboardingListCategoryVolumes (Maybe OnboardingListCategoryVolumesMaxAllowedMaturityRating)

The maximum allowed maturity rating of returned volumes. Books with a higher maturity rating are filtered out.

olcvCategoryId :: Lens' OnboardingListCategoryVolumes [Text]

List of category ids requested.

olcvPageToken :: Lens' OnboardingListCategoryVolumes (Maybe Text)

The value of the nextToken from the previous page.

olcvPageSize :: Lens' OnboardingListCategoryVolumes (Maybe Word32)

Number of maximum results per page to be included in the response.