@maxim_mazurok/gapi.client.domainsrdap-v1
TypeScript icon, indicating that this package has built-in type declarations

0.0.20240618 • Public • Published

TypeScript typings for Domains RDAP API v1

Read-only public API that lets users search for information about domain names. For detailed description please check documentation.

Installing

Install typings for Domains RDAP API:

npm install @types/gapi.client.domainsrdap-v1 --save-dev

Usage

You need to initialize Google API client in your code:

gapi.load('client', () => {
  // now we can use gapi.client
  // ...
});

Then load api client wrapper:

gapi.client.load(
  'https://domainsrdap.googleapis.com/$discovery/rest?version=v1',
  () => {
    // now we can use:
    // gapi.client.domainsrdap
  }
);
// Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
gapi.client.load('domainsrdap', 'v1', () => {
  // now we can use:
  // gapi.client.domainsrdap
});

After that you can use Domains RDAP API resources:

/*
The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error.
*/
await gapi.client.domainsrdap.autnum.get({autnumId: 'autnumId'});

/*
Look up RDAP information for a domain by name.
*/
await gapi.client.domainsrdap.domain.get({domainName: 'domainName'});

/*
The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error.
*/
await gapi.client.domainsrdap.entity.get({entityId: 'entityId'});

/*
The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error.
*/
await gapi.client.domainsrdap.ip.get({ipId: 'ipId', ipId1: 'ipId1'});

/*
The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error.
*/
await gapi.client.domainsrdap.nameserver.get({nameserverId: 'nameserverId'});

/*
The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error.
*/
await gapi.client.domainsrdap.getDomains({});

/*
The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error.
*/
await gapi.client.domainsrdap.getEntities({});

/*
Get help information for the RDAP API, including links to documentation.
*/
await gapi.client.domainsrdap.getHelp({});

/*
The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error.
*/
await gapi.client.domainsrdap.getIp({});

/*
The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error.
*/
await gapi.client.domainsrdap.getNameservers({});

Readme

Keywords

none

Package Sidebar

Install

npm i @maxim_mazurok/gapi.client.domainsrdap-v1

Weekly Downloads

1,032

Version

0.0.20240618

License

MIT

Unpacked Size

20.6 kB

Total Files

3

Last publish

Collaborators

  • maxim_mazurok