Gcp/books

@swamp/gcp/booksv2026.08.12.2· 17d agoMODELS

01README

Google Cloud books infrastructure models

02Release Notes

Updated: bookshelves, bookshelves_volumes, layers, layers_annotationdata, layers_volumeannotations, mylibrary_annotations, mylibrary_bookshelves, mylibrary_bookshelves_volumes, mylibrary_readingpositions, notification, personalizedstream, promooffer, series, series_membership, volumes, volumes_associated, volumes_mybooks, volumes_recommended, volumes_useruploaded

03Models19

@swamp/gcp/books/bookshelvesv2026.08.12.2bookshelves.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
userId	string	yes	ID of user for whom to retrieve bookshelves.

fn get(identifier: string)

Get a bookshelves

Argument	Type	Required	Description
identifier	string	yes	The name of the bookshelves

fn sync(identifier?: string)

Sync bookshelves state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific bookshelves by name (e.g. one discovered by list)

fn list(source?: string, maxPages?: number)

List bookshelves resources

Argument	Type	Required	Description
source?	string	no	String to identify the originator of this request.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Retrieves metadata for a specific bookshelf for the specified user.

@swamp/gcp/books/bookshelves-volumesv2026.08.12.2bookshelves_volumes.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
userId	string	yes	ID of user for whom to retrieve bookshelf volumes.
shelf	string	yes	ID of bookshelf to retrieve volumes.

fn get(identifier: string)

Get a volumes

Argument	Type	Required	Description
identifier	string	yes	The name of the volumes

fn sync(identifier?: string)

Sync volumes state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific volumes by name (e.g. one discovered by list)

fn list(maxResults?: number, showPreorders?: boolean, source?: string, startIndex?: number, maxPages?: number)

List volumes resources

Argument	Type	Required	Description
maxResults?	number	no	Maximum number of results to return
showPreorders?	boolean	no	Set to true to show pre-ordered books. Defaults to false.
source?	string	no	String to identify the originator of this request.
startIndex?	number	no	Index of the first element to return (starts at 0)
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Retrieves volumes in a specific bookshelf for the specified user.

@swamp/gcp/books/layersv2026.08.12.2layers.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
volumeId	string	yes	The volume to retrieve layers for.

fn get(identifier: string)

Get a layers

Argument	Type	Required	Description
identifier	string	yes	The name of the layers

fn sync(identifier?: string)

Sync layers state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific layers by name (e.g. one discovered by list)

fn list(contentVersion?: string, maxResults?: number, source?: string, maxPages?: number)

List layers resources

Argument	Type	Required	Description
contentVersion?	string	no	The content version for the requested volume.
maxResults?	number	no	Maximum number of results to return
source?	string	no	String to identify the originator of this request.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Gets the layer summary for a volume.

@swamp/gcp/books/layers-annotationdatav2026.08.12.2layers_annotationdata.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
volumeId	string	yes	The volume to retrieve annotations for.
layerId	string	yes	The ID for the layer to get the annotations.
annotationDataId	string	yes	The ID of the annotation data to retrieve.
contentVersion	string	yes	The content version for the requested volume.

fn get(identifier: string)

Get a annotationData

Argument	Type	Required	Description
identifier	string	yes	The name of the annotationData

fn sync(identifier?: string)

Sync annotationData state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific annotationData by name (e.g. one discovered by list)

fn list(annotationDataId?: string, contentVersion?: string, h?: number, locale?: string, maxResults?: number, scale?: number, source?: string, updatedMax?: string, updatedMin?: string, w?: number, maxPages?: number)

List annotationData resources

Argument	Type	Required	Description
annotationDataId?	string	no	The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set.
contentVersion?	string	no	The content version for the requested volume.
h?	number	no	The requested pixel height for any images. If height is provided width must also be provided.
locale?	string	no	The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
maxResults?	number	no	Maximum number of results to return
scale?	number	no	The requested scale for the image.
source?	string	no	String to identify the originator of this request.
updatedMax?	string	no	RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
updatedMin?	string	no	RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
w?	number	no	The requested pixel width for any images. If width is provided height must also be provided.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Gets the annotation data.

@swamp/gcp/books/layers-volumeannotationsv2026.08.12.2layers_volumeannotations.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
volumeId	string	yes	The volume to retrieve annotations for.
layerId	string	yes	The ID for the layer to get the annotations.
contentVersion	string	yes	The content version for the requested volume.

fn get(identifier: string)

Get a volumeAnnotations

Argument	Type	Required	Description
identifier	string	yes	The name of the volumeAnnotations

fn sync(identifier?: string)

Sync volumeAnnotations state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific volumeAnnotations by name (e.g. one discovered by list)

fn list(contentVersion?: string, endOffset?: string, endPosition?: string, locale?: string, maxResults?: number, showDeleted?: boolean, source?: string, startOffset?: string, startPosition?: string, updatedMax?: string, updatedMin?: string, volumeAnnotationsVersion?: string, maxPages?: number)

List volumeAnnotations resources

Argument	Type	Required	Description
contentVersion?	string	no	The content version for the requested volume.
endOffset?	string	no	The end offset to end retrieving data from.
endPosition?	string	no	The end position to end retrieving data from.
locale?	string	no	The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
maxResults?	number	no	Maximum number of results to return
showDeleted?	boolean	no	Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
source?	string	no	String to identify the originator of this request.
startOffset?	string	no	The start offset to start retrieving data from.
startPosition?	string	no	The start position to start retrieving data from.
updatedMax?	string	no	RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
updatedMin?	string	no	RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
volumeAnnotationsVersion?	string	no	The version of the volume annotations that you are requesting.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Gets the volume annotation.

@swamp/gcp/books/mylibrary-annotationsv2026.08.12.2mylibrary_annotations.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
afterSelectedText?	string	no	Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
beforeSelectedText?	string	no	Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
clientVersionRanges?	object	no	Selection ranges sent from the client.
created?	string	no	Timestamp for the created time of this annotation.
currentVersionRanges?	object	no	Selection ranges for the most recent content version.
data?	string	no	User-created data for this annotation.
deleted?	boolean	no	Indicates that this annotation is deleted.
highlightStyle?	string	no	The highlight style for this annotation.
id?	string	no	Id of this annotation, in the form of a GUID.
layerId?	string	no	The layer this annotation is for.
layerSummary?	object	no
pageIds?	array	no	Pages that this annotation spans.
selectedText?	string	no	Excerpt from the volume.
updated?	string	no	Timestamp for the last time this annotation was modified.
volumeId?	string	no	The volume that this annotation belongs to.
annotationId?	string	no	The ID for the annotation to insert.
country?	string	no	ISO-3166-1 code to override the IP-based location.
showOnlySummaryInResponse?	string	no	Requests that only the summary of the specified layer be provided in the response.
source?	string	no	String to identify the originator of this request.

fn create()

Create a annotations

fn get(identifier: string)

Get a annotations

Argument	Type	Required	Description
identifier	string	yes	The name of the annotations

fn update(identifier?: string)

Update annotations attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific annotations by name (e.g. one discovered by list)

fn delete(identifier: string)

Delete the annotations

Argument	Type	Required	Description
identifier	string	yes	The name of the annotations

fn sync(identifier?: string)

Sync annotations state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific annotations by name (e.g. one discovered by list)

fn list(contentVersion?: string, layerId?: string, layerIds?: string, maxResults?: number, showDeleted?: boolean, source?: string, updatedMax?: string, updatedMin?: string, volumeId?: string, maxPages?: number)

List annotations resources

Argument	Type	Required	Description
contentVersion?	string	no	The content version for the requested volume.
layerId?	string	no	The layer ID to limit annotation by.
layerIds?	string	no	The layer ID(s) to limit annotation by.
maxResults?	number	no	Maximum number of results to return
showDeleted?	boolean	no	Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
source?	string	no	String to identify the originator of this request.
updatedMax?	string	no	RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
updatedMin?	string	no	RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
volumeId?	string	no	The volume to restrict annotations to.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn summary()

summary

Resources

state(infinite)— Retrieves a list of annotations, possibly filtered.

@swamp/gcp/books/mylibrary-bookshelvesv2026.08.12.2mylibrary_bookshelves.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
shelf	string	yes	ID of bookshelf from which to remove a volume.

fn get(identifier: string)

Get a bookshelves

Argument	Type	Required	Description
identifier	string	yes	The name of the bookshelves

fn delete(identifier: string)

Delete the bookshelves

Argument	Type	Required	Description
identifier	string	yes	The name of the bookshelves

fn sync(identifier?: string)

Sync bookshelves state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific bookshelves by name (e.g. one discovered by list)

fn list(source?: string, maxPages?: number)

List bookshelves resources

Argument	Type	Required	Description
source?	string	no	String to identify the originator of this request.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn add_volume()

add volume

fn clear_volumes()

clear volumes

fn move_volume()

move volume

Resources

state(infinite)— Retrieves metadata for a specific bookshelf belonging to the authenticated user.

@swamp/gcp/books/mylibrary-bookshelves-volumesv2026.08.12.2mylibrary_bookshelves_volumes.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
shelf	string	yes	The bookshelf ID or name retrieve volumes for.

fn get(identifier: string)

Get a volumes

Argument	Type	Required	Description
identifier	string	yes	The name of the volumes

fn sync(identifier?: string)

Sync volumes state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific volumes by name (e.g. one discovered by list)

fn list(country?: string, maxResults?: number, projection?: string, q?: string, showPreorders?: boolean, source?: string, startIndex?: number, maxPages?: number)

List volumes resources

Argument	Type	Required	Description
country?	string	no	ISO-3166-1 code to override the IP-based location.
maxResults?	number	no	Maximum number of results to return
projection?	string	no	Restrict information returned to a set of selected fields.
q?	string	no	Full-text search query string in this bookshelf.
showPreorders?	boolean	no	Set to true to show pre-ordered books. Defaults to false.
source?	string	no	String to identify the originator of this request.
startIndex?	number	no	Index of the first element to return (starts at 0)
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Gets volume information for volumes on a bookshelf.

@swamp/gcp/books/mylibrary-readingpositionsv2026.08.12.2mylibrary_readingpositions.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.

fn get(identifier: string)

Get a readingpositions

Argument	Type	Required	Description
identifier	string	yes	The name of the readingpositions

fn sync(identifier?: string)

Sync readingpositions state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific readingpositions by name (e.g. one discovered by list)

fn set_position()

set position

Resources

state(infinite)— Retrieves my reading position information for a volume.

@swamp/gcp/books/notificationv2026.08.12.2notification.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.

fn get(identifier: string)

Get a notification

Argument	Type	Required	Description
identifier	string	yes	The name of the notification

fn sync(identifier?: string)

Sync notification state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific notification by name (e.g. one discovered by list)

Resources

state(infinite)— Returns notification details for a given notification id.

@swamp/gcp/books/personalizedstreamv2026.08.12.2personalizedstream.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.

fn get(identifier: string)

Get a personalizedstream

Argument	Type	Required	Description
identifier	string	yes	The name of the personalizedstream

fn sync(identifier?: string)

Sync personalizedstream state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific personalizedstream by name (e.g. one discovered by list)

Resources

state(infinite)— Returns a stream of personalized book clusters

@swamp/gcp/books/promoofferv2026.08.12.2promooffer.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.

fn get(identifier: string)

Get a promooffer

Argument	Type	Required	Description
identifier	string	yes	The name of the promooffer

fn sync(identifier?: string)

Sync promooffer state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific promooffer by name (e.g. one discovered by list)

fn accept()

fn dismiss()

dismiss

Resources

state(infinite)— Returns a list of promo offers available to the user

@swamp/gcp/books/seriesv2026.08.12.2series.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.

fn get(identifier: string)

Get a series

Argument	Type	Required	Description
identifier	string	yes	The name of the series

fn sync(identifier?: string)

Sync series state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific series by name (e.g. one discovered by list)

Resources

state(infinite)— Returns Series metadata for the given series ids.

@swamp/gcp/books/series-membershipv2026.08.12.2series_membership.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.

fn get(identifier: string)

Get a membership

Argument	Type	Required	Description
identifier	string	yes	The name of the membership

fn sync(identifier?: string)

Sync membership state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific membership by name (e.g. one discovered by list)

Resources

state(infinite)— Returns Series membership data given the series id.

@swamp/gcp/books/volumesv2026.08.12.2volumes.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
q	string	yes	Full-text search query string.

fn get(identifier: string)

Get a volumes

Argument	Type	Required	Description
identifier	string	yes	The name of the volumes

fn sync(identifier?: string)

Sync volumes state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific volumes by name (e.g. one discovered by list)

fn list(download?: string, filter?: string, langRestrict?: string, libraryRestrict?: string, maxAllowedMaturityRating?: string, maxResults?: number, orderBy?: string, partner?: string, printType?: string, projection?: string, q?: string, showPreorders?: boolean, source?: string, startIndex?: number, maxPages?: number)

List volumes resources

Argument	Type	Required	Description
download?	string	no	Restrict to volumes by download availability.
filter?	string	no	Filter search results.
langRestrict?	string	no	Restrict results to books with this language code.
libraryRestrict?	string	no	Restrict search to this user's library.
maxAllowedMaturityRating?	string	no	The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
maxResults?	number	no	Maximum number of results to return.
orderBy?	string	no	Sort search results.
partner?	string	no	Restrict and brand results for partner ID.
printType?	string	no	Restrict to books or magazines.
projection?	string	no	Restrict information returned to a set of selected fields.
q?	string	no	Full-text search query string.
showPreorders?	boolean	no	Set to true to show books available for preorder. Defaults to false.
source?	string	no	String to identify the originator of this request.
startIndex?	number	no	Index of the first result to return (starts at 0)
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Gets volume information for a single volume.

@swamp/gcp/books/volumes-associatedv2026.08.12.2volumes_associated.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
volumeId	string	yes	ID of the source volume.

fn get(identifier: string)

Get a associated

Argument	Type	Required	Description
identifier	string	yes	The name of the associated

fn sync(identifier?: string)

Sync associated state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific associated by name (e.g. one discovered by list)

fn list(association?: string, locale?: string, maxAllowedMaturityRating?: string, source?: string, maxPages?: number)

List associated resources

Argument	Type	Required	Description
association?	string	no	Association type.
locale?	string	no	ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
maxAllowedMaturityRating?	string	no	The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
source?	string	no	String to identify the originator of this request.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Return a list of associated books.

@swamp/gcp/books/volumes-mybooksv2026.08.12.2volumes_mybooks.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.

fn get(identifier: string)

Get a mybooks

Argument	Type	Required	Description
identifier	string	yes	The name of the mybooks

fn sync(identifier?: string)

Sync mybooks state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific mybooks by name (e.g. one discovered by list)

fn list(acquireMethod?: string, country?: string, locale?: string, maxResults?: number, processingState?: string, source?: string, startIndex?: number, maxPages?: number)

List mybooks resources

Argument	Type	Required	Description
acquireMethod?	string	no	How the book was acquired
country?	string	no	ISO-3166-1 code to override the IP-based location.
locale?	string	no	ISO-639-1 language and ISO-3166-1 country code. Ex:'en_US'. Used for generating recommendations.
maxResults?	number	no	Maximum number of results to return.
processingState?	string	no	The processing state of the user uploaded volumes to be returned. Applicable only if the UPLOADED is specified in the acquireMethod.
source?	string	no	String to identify the originator of this request.
startIndex?	number	no	Index of the first result to return (starts at 0)
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Return a list of books in My Library.

@swamp/gcp/books/volumes-recommendedv2026.08.12.2volumes_recommended.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.

fn get(identifier: string)

Get a recommended

Argument	Type	Required	Description
identifier	string	yes	The name of the recommended

fn sync(identifier?: string)

Sync recommended state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific recommended by name (e.g. one discovered by list)

fn list(locale?: string, maxAllowedMaturityRating?: string, source?: string, maxPages?: number)

List recommended resources

Argument	Type	Required	Description
locale?	string	no	ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
maxAllowedMaturityRating?	string	no	The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
source?	string	no	String to identify the originator of this request.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn rate()

rate

Resources

state(infinite)— Return a list of recommended books for the current user.

@swamp/gcp/books/volumes-useruploadedv2026.08.12.2volumes_useruploaded.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.

fn get(identifier: string)

Get a useruploaded

Argument	Type	Required	Description
identifier	string	yes	The name of the useruploaded

fn sync(identifier?: string)

Sync useruploaded state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific useruploaded by name (e.g. one discovered by list)

fn list(locale?: string, maxResults?: number, processingState?: string, source?: string, startIndex?: number, volumeId?: string, maxPages?: number)

List useruploaded resources

Argument	Type	Required	Description
locale?	string	no	ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
maxResults?	number	no	Maximum number of results to return.
processingState?	string	no	The processing state of the user uploaded volumes to be returned.
source?	string	no	String to identify the originator of this request.
startIndex?	number	no	Index of the first result to return (starts at 0)
volumeId?	string	no	The ids of the volumes to be returned. If not specified all that match the processingState are returned.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Return a list of books uploaded by the current user.

04Previous Versions19

2026.07.29.1Jul 30, 2026

Updated: bookshelves, bookshelves_volumes, layers, layers_annotationdata, layers_volumeannotations, mylibrary_annotations, mylibrary_bookshelves, mylibrary_bookshelves_volumes, mylibrary_readingpositions, notification, personalizedstream, promooffer, series, series_membership, volumes, volumes_associated, volumes_mybooks, volumes_recommended, volumes_useruploaded

2026.07.21.3Jul 21, 2026

Updated: bookshelves, bookshelves_volumes, layers, layers_annotationdata, layers_volumeannotations, mylibrary_annotations, mylibrary_bookshelves, mylibrary_bookshelves_volumes, mylibrary_readingpositions, notification, personalizedstream, promooffer, series, series_membership, volumes, volumes_associated, volumes_mybooks, volumes_recommended, volumes_useruploaded

2026.07.21.1Jul 21, 2026

Updated: mylibrary_annotations

2026.07.20.1Jul 20, 2026

Updated: bookshelves, bookshelves_volumes, layers, layers_annotationdata, layers_volumeannotations, mylibrary_annotations, mylibrary_bookshelves, mylibrary_bookshelves_volumes, mylibrary_readingpositions, notification, personalizedstream, promooffer, series, series_membership, volumes, volumes_associated, volumes_mybooks, volumes_recommended, volumes_useruploaded

2026.07.19.2Jul 19, 2026

Updated: bookshelves, bookshelves_volumes, layers, layers_annotationdata, layers_volumeannotations, mylibrary_bookshelves, mylibrary_bookshelves_volumes, volumes, volumes_associated

2026.07.19.1Jul 19, 2026

Updated: bookshelves, bookshelves_volumes, layers, layers_annotationdata, layers_volumeannotations, mylibrary_annotations, mylibrary_bookshelves, mylibrary_bookshelves_volumes, mylibrary_readingpositions, notification, personalizedstream, promooffer, series, series_membership, volumes, volumes_associated, volumes_mybooks, volumes_recommended, volumes_useruploaded

2026.07.18.1Jul 18, 2026

Updated: bookshelves, bookshelves_volumes, layers, layers_annotationdata, layers_volumeannotations, mylibrary_annotations, mylibrary_bookshelves, mylibrary_bookshelves_volumes, mylibrary_readingpositions, notification, personalizedstream, promooffer, series, series_membership, volumes, volumes_associated, volumes_mybooks, volumes_recommended, volumes_useruploaded

2026.07.17.1Jul 17, 2026

Updated: mylibrary_annotations

Added 19, removed 1 models

2026.06.08.2Jun 8, 2026

Updated: bookshelves, bookshelves_volumes, layers, layers_annotationdata, layers_volumeannotations, mylibrary_annotations, mylibrary_bookshelves, mylibrary_bookshelves_volumes, mylibrary_readingpositions, notification, personalizedstream, promooffer, series, series_membership, volumes, volumes_associated, volumes_mybooks, volumes_recommended, volumes_useruploaded

2026.06.07.1Jun 7, 2026

Updated: bookshelves, bookshelves_volumes, layers, layers_annotationdata, layers_volumeannotations, mylibrary_annotations, mylibrary_bookshelves, mylibrary_bookshelves_volumes, mylibrary_readingpositions, notification, personalizedstream, promooffer, series, series_membership, volumes, volumes_associated, volumes_mybooks, volumes_recommended, volumes_useruploaded

2026.05.25.2May 25, 2026

Updated: mylibrary_annotations, mylibrary_bookshelves, volumes_mybooks, volumes_recommended, volumes_useruploaded

Modified 13 models

2026.05.24.1May 24, 2026

Updated: bookshelves, bookshelves_volumes, layers, layers_annotationdata, layers_volumeannotations, mylibrary_annotations, mylibrary_bookshelves, mylibrary_bookshelves_volumes, mylibrary_readingpositions, notification, personalizedstream, promooffer, series, series_membership, volumes, volumes_associated, volumes_mybooks, volumes_recommended, volumes_useruploaded

2026.05.21.2May 21, 2026

Updated: bookshelves, bookshelves_volumes, layers, layers_annotationdata, layers_volumeannotations, mylibrary_annotations, mylibrary_bookshelves, mylibrary_bookshelves_volumes, mylibrary_readingpositions, notification, personalizedstream, promooffer, series, series_membership, volumes, volumes_associated, volumes_mybooks, volumes_recommended, volumes_useruploaded

2026.05.21.1May 21, 2026

2026.05.19.2May 19, 2026

2026.05.19.1May 19, 2026

2026.04.23.1Apr 23, 2026

2026.04.04.1Apr 4, 2026

Updated: bookshelves_volumes, layers_annotationdata, mylibrary_bookshelves_volumes, personalizedstream, series_membership, volumes, volumes_associated, volumes_mybooks, volumes_recommended, volumes_useruploaded

2026.04.03.3Apr 3, 2026

Updated: bookshelves, bookshelves_volumes, layers, layers_annotationdata, layers_volumeannotations, mylibrary_annotations, mylibrary_bookshelves, mylibrary_bookshelves_volumes, mylibrary_readingpositions, notification, personalizedstream, promooffer, series, series_membership, volumes, volumes_associated, volumes_mybooks, volumes_recommended, volumes_useruploaded

05Stats

100 / 100

Downloads

Archive size

136.0 KB

Verified by Swamp

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types (deprecated)1/1earned
Dependencies pass trust audit2/2earned
Has description1/1earned
Platform support declared (or universal)2/2earned
License declared1/1earned
Verified public repository2/2earned

Repository

https://github.com/swamp-club/swamp-extensions

06Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

07Labels

#gcp #google-cloud #books #cloud #infrastructure