Module isbndb
ballerinax/isbndb Ballerina library
1.5.2
Overview
The ISBNdb API v2.0.0 connector(https://isbndb.com/apidocs/v2) OpenAPI specification.
The ISBNdb.com API exposes data such as title, author, publisher and publish date about books.
Clients
isbndb: Client
Isolated
This is a generated connector for ISBNdb API v2.0.0 OpenAPI specification. The ISBNdb.com API exposes data such as title, author, publisher and publish date about books.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Create a ISBNdb Account by selecting a pricing plan and obtain tokens following this guide.
init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)- apiKeyConfig ApiKeysConfig - API keys for authorization
- config ConnectionConfig {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://api2.isbndb.com/" - URL of the target service
getAuthorDetails
Isolated FunctionRemote Function
Gets author details
Parameters
- name string - The name of an author in the Author's database
- page int (default 1) - The number of page to retrieve, please note the API will not return more than 10,000 results no matter how you paginate them
- pageSize int (default 20) - How many items should be returned per page, maximum of 1,000
searchAuthors
Isolated FunctionRemote Function
function searchAuthors(string query, string? pageSize, string? page) returns AuthorQueryResults|errorSearch authors
Parameters
- query string - A string to search for in the Author’s database
- pageSize string? (default ()) - How many items should be returned per page, maximum of 1,000
- page string? (default ()) - The number of page to retrieve, please note the API will not return more than 10,000 results no matter how you paginate them
Return Type
- AuthorQueryResults|error - The query string found results in the author's database
getBookDetails
Isolated FunctionRemote Function
Gets book details
Parameters
- isbn string - an ISBN 10 or ISBN 13 in the Books database
- withPrices string? (default ()) - indicate if shows Real Time Prices. Only with the Pro plan
searchBooks
Isolated FunctionRemote Function
Search books
Parameters
- payload BooksBody - Request payload to search to search books
searchBooksByQuery
Isolated FunctionRemote Function
function searchBooksByQuery(string query, int page, int pageSize, string? column, int beta) returns Response|errorSearch books
Parameters
- query string - A string to search for in the Book’s database
- page int (default 1) - The number of page to retrieve, please note the API will not return more than 10,000 results no matter how you paginate them
- pageSize int (default 20) - How many items should be returned per page, maximum of 1,000
- column string? (default ()) - Search limited to this column: *
- Empty value search in every column * `title` - Only searches in Books Title * `author` - Only searches books by the given Author * `date_published` - Only searches books in a given year, e.g. 1998 MISSING[]+ beta - A integer (1 or 0) for enable or disable beta searching.- return - The query string found results in the books's database
- beta int (default 0) -
getPublisherDetails
Isolated FunctionRemote Function
Gets publisher details
Parameters
- name string - The name of a publisher in the Publisher's database
- page int (default 1) - The number of page to retrieve, please note the API will not return more than 10,000 results no matter how you paginate them
- pageSize int (default 20) - How many items should be returned per page, maximum of 1,000
searchPublishers
Isolated FunctionRemote Function
Search publishers
Parameters
- query string - A string to search for in the Publisher’s database
- pageSize string? (default ()) - How many items should be returned per page, maximum of 1,000
- page string? (default ()) - The number of page to retrieve, please note the API will not return more than 10,000 results no matter how you paginate them
searchISBNDB
Isolated FunctionRemote Function
function searchISBNDB(string index, string? page, string? pageSize, string? isbn, string? isbn13, string? author, string? text, string? subject, string? publisher) returns Response|errorSearch all ISBNDB databases
Parameters
- index string - Only this values are valids: subjects, publishers, authors y books
- page string? (default ()) - The number of page to retrieve, please note the API will not return more than 10,000 results no matter how you paginate them
- pageSize string? (default ()) - How many items should be returned per page, maximum of 1,000
- isbn string? (default ()) - an ISBN 10 in the Books database
- isbn13 string? (default ()) - an ISBN 13 in the Books database
- author string? (default ()) - The name of an author in the Author's database
- text string? (default ()) - A string to search for determinated index database
- subject string? (default ()) - A subject in the Subject's database
- publisher string? (default ()) - The name of a publisher in the Publisher's database
getISBNDBStatus
Isolated FunctionRemote Function
Gets status on the ISBNDB Database
getSubjectDetails
Isolated FunctionRemote Function
Gets subject details
Parameters
- name string - A subject in the Subject's database
searchSubject
Isolated FunctionRemote Function
Search subjects
Parameters
- query string - A string to search for in the Subject’s database
- pageSize string? (default ()) - How many items should be returned per page, maximum of 1,000
- page string? (default ()) - The number of page to retrieve, please note the API will not return more than 10,000 results no matter how you paginate them
Records
isbndb: ApiKeysConfig
Closed record
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
isbndb: Author
Describes the name of an author and the books written by that author in the database
Fields
- books? Book[] - Detail about books written by author
isbndb: AuthorQueryResults
Describes the results of a query in the author's database
Fields
- total? int -
isbndb: Book
Describes a book in the book's database
Fields
- title? string -
- title_long? string -
- isbn? string -
- isbn13? string -
- dewey_decimal? string -
- binding? string -
- publisher? string -
- language? string -
- date_published? string -
- edition? string -
- pages? int -
- dimensions? string -
- overview? string -
- image? CoverLink - The link to the cover image
- msrp? decimal -
- excerpt? string -
- synopsys? string -
- subjects? string[] -
- reviews? string[] -
- prices? Merchant[] - Only shows if the query param 'with_prices' is present.
isbndb: BookRelated
Fields
- 'type? string -
isbndb: BooksBody
Fields
- isbns string[] - a list of ISBN 10 or ISBN 13 in the Books database
isbndb: BooksBody1
Fields
- isbns string[] - a list of ISBN 10 or ISBN 13 in the Books database
isbndb: ClientHttp1Settings
Closed record
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy? ProxyConfig - Proxy server related options
isbndb: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings? ClientHttp1Settings - Configurations related to HTTP/1.x protocol
- http2Settings? ClientHttp2Settings - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache? CacheConfig - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- responseLimits? ResponseLimitConfigs - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
isbndb: Merchant
Describe the conditions of the price by merchant. Only with the Pro plan
Fields
- condition? string -
- merchant? string -
- merchant_logo? string -
- merchant_logo_offset? MerchantMerchantLogoOffset -
- shipping? string -
- price? string -
- total? string -
- link? string -
isbndb: MerchantMerchantLogoOffset
Fields
- x? string - Merchant logo x-offset
- y? string - Merchant logo y-offset
isbndb: ProxyConfig
Closed record
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
isbndb: Publisher
Describes about book publisher details
Fields
- name? string - Name of book publisher
- books? PublisherBooks[] - Details of books published
isbndb: PublisherBooks
Details of books published
Fields
- isbn? string -
isbndb: Subject
Describes about what the book is about
Fields
- subject? string -
- parent? string -
String types
isbndb: CoverLink
CoverLink
The link to the cover image