Ballerina library

isbndb

Module isbndb

Overview

API

Client

Definitions

ApiKeysConfig
Author
AuthorQueryResults
Book
BookRelated
BooksBody
BooksBody1
ClientHttp1Settings
ConnectionConfig
Merchant
MerchantMerchantLogoOffset
ProxyConfig
Publisher
PublisherBooks
Subject

CoverLink

ballerinax/isbndb Ballerina library

1.5.1

Overview

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.

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)
  • 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
function getAuthorDetails(string name, int page, int pageSize) returns Author|error

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
Return Type
  • Author|error - The author name was found in the database

searchAuthors

Isolated FunctionRemote Function
function searchAuthors(string query, string? pageSize, string? page) returns AuthorQueryResults|error

Search 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

getBookDetails

Isolated FunctionRemote Function
function getBookDetails(string isbn, string? withPrices) returns Book|error

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
Return Type
  • Book|error - The book ISBN was found in the database

searchBooks

Isolated FunctionRemote Function
function searchBooks(BooksBody payload) returns Response|error

Search books

Parameters
  • payload BooksBody - Request payload to search to search books
Return Type
  • Response|error - The query string found results in the book's database

searchBooksByQuery

Isolated FunctionRemote Function
function searchBooksByQuery(string query, int page, int pageSize, string? column, int beta) returns Response|error

Search 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
function getPublisherDetails(string name, int page, int pageSize) returns Publisher|error

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
Return Type

searchPublishers

Isolated FunctionRemote Function
function searchPublishers(string query, string? pageSize, string? page) returns Response|error

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
Return Type
  • Response|error - The query string found results in the publisher's database

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

Search 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
Return Type

getISBNDBStatus

Isolated FunctionRemote Function
function getISBNDBStatus() returns Response|error

Gets status on the ISBNDB Database

Return Type

getSubjectDetails

Isolated FunctionRemote Function
function getSubjectDetails(string name) returns Subject|error

Gets subject details

Parameters
  • name string - A subject in the Subject's database
Return Type

searchSubject

Isolated FunctionRemote Function
function searchSubject(string query, string? pageSize, string? page) returns Response|error

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
Return Type
  • Response|error - The query string found results in the subject's database

Records

isbndb: ApiKeysConfig

Closed record

Provides API key configurations needed when communicating with a remote HTTP endpoint.

Fields
  • authorization string - All requests on the ISBNdb.com API needs to include an API key. The API key can be provided as part of the query string or as a request header. The name of the API key needs to be Authorization.

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

isbndb: Book

Describes a book in the book's database

Fields
  • image CoverLink? - The link to the cover image
  • prices Merchant[]? - Only shows if the query param 'with_prices' is present.

isbndb: BookRelated

Fields

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

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
  • 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-forwarded header
  • 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
  • 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

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

isbndb: PublisherBooks

Details of books published

Fields

isbndb: Subject

Describes about what the book is about

Fields

String types

string

CoverLink

The link to the cover image

Import

import ballerinax/isbndb;Copy

Metadata

Released date: 12 months ago

Version: 1.5.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 0

Current verison: 0

Weekly downloads

Source repository

Keywords

Lifestyle & Entertainment/Books

Cost/Paid

Contributors

Other versions

1.5.1

1.5.01.4.01.2.01.1.0
See more...

Dependencies

ballerina/url/2.2.3ballerina/http/2.6.1

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2024 WSO2 LLC