npm package: @superlink-me/superlink
Description: API for Superlink
Latest version: 0.5.0

# @superlink-me/superlink

SuperlinkMeSuperlink - JavaScript client for @superlink-me/superlink
API for Superlink
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: v0.5.0
- Package version: v0.5.0
- Generator version: 7.5.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
For more information, please visit [https://superlink.me/about#contact-us](https://superlink.me/about#contact-us)

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install @superlink-me/superlink --save
```

Finally, you need to build the module:

```shell
npm run build
```

##### Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
npm link
```

To use the link you just defined in your project, switch to the directory you want to use your @superlink-me/superlink from, and run:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

Finally, you need to build the module:

```shell
npm run build
```

#### git

If the library is hosted at a git repository, e.g.https://github.com/superlink-me/superlink-api-javascript-client
then install it via:

```shell
    npm install superlink-me/superlink-api-javascript-client --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
the above steps with Node.js and installing browserify with `npm install -g browserify`,
perform the following (assuming *main.js* is your entry file):

```shell
browserify main.js > bundle.js
```

Then include *bundle.js* in the HTML pages.

### Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error:
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
the following section to your webpack config:

```javascript
module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}
```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
var SuperlinkMeSuperlink = require('@superlink-me/superlink');

var defaultClient = SuperlinkMeSuperlink.ApiClient.instance;
// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new SuperlinkMeSuperlink.AdminApi()
var request = new SuperlinkMeSuperlink.ApiAdminAccessTokenCreateRequest(); // {ApiAdminAccessTokenCreateRequest} access token create request
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.adminCreateAccessToken(request, callback);

```

## Documentation for API Endpoints

All URIs are relative to *https://api.superlink.me*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*SuperlinkMeSuperlink.AdminApi* | [**adminCreateAccessToken**](docs/AdminApi.md#adminCreateAccessToken) | **POST** /v1/admin/access-token | Creates an admin token
*SuperlinkMeSuperlink.AdminApi* | [**adminDeleteAccessToken**](docs/AdminApi.md#adminDeleteAccessToken) | **DELETE** /v1/admin/access-token | Deletes an access token
*SuperlinkMeSuperlink.AdminApi* | [**adminListAccessTokens**](docs/AdminApi.md#adminListAccessTokens) | **GET** /v1/admin/access-token | Lists access tokens
*SuperlinkMeSuperlink.AdminApi* | [**adminListPartners**](docs/AdminApi.md#adminListPartners) | **GET** /v1/admin/partner | Lists partners
*SuperlinkMeSuperlink.AdminApi* | [**adminPartnerCreate**](docs/AdminApi.md#adminPartnerCreate) | **POST** /v1/admin/partner | Creates a partner
*SuperlinkMeSuperlink.AdminApi* | [**hnsTldRegister**](docs/AdminApi.md#hnsTldRegister) | **POST** /v1/admin/hns/tld/register | HNSTLDRegister registers a Handshake TLD
*SuperlinkMeSuperlink.AdminApi* | [**removeReverseResolutionAddress**](docs/AdminApi.md#removeReverseResolutionAddress) | **DELETE** /v1/admin/reverse | Removes a reverse resolution address from a domain
*SuperlinkMeSuperlink.AdminApi* | [**setReverseResolutionAddress**](docs/AdminApi.md#setReverseResolutionAddress) | **POST** /v1/admin/reverse | Assigns an address to a domain for reverse resolution
*SuperlinkMeSuperlink.DefaultApi* | [**healthCheck**](docs/DefaultApi.md#healthCheck) | **GET** /v1/health | Checks the health of the API
*SuperlinkMeSuperlink.DomainInfoApi* | [**getAllDomains**](docs/DomainInfoApi.md#getAllDomains) | **GET** /v1/domain | Returns all the domains owned by a given ownerAddress
*SuperlinkMeSuperlink.HnsApi* | [**hnsDomainAvailable**](docs/HnsApi.md#hnsDomainAvailable) | **GET** /v1/hns/tld/{tld}/sld/{sld}/available | checks if a handshake domain is available to mint
*SuperlinkMeSuperlink.HnsApi* | [**hnsDomainCreate**](docs/HnsApi.md#hnsDomainCreate) | **POST** /v1/hns/tld/{tld}/sld/mint | HNSCreateDomain creates a handshake domain
*SuperlinkMeSuperlink.HnsApi* | [**hnsDomainCreateSig**](docs/HnsApi.md#hnsDomainCreateSig) | **POST** /v1/hns/tld/{tld}/sld/mint-with-sig | creates a handshake domain authenticated by a signed message
*SuperlinkMeSuperlink.HnsApi* | [**hnsDomainDelete**](docs/HnsApi.md#hnsDomainDelete) | **DELETE** /v1/hns/tld/{tld}/sld/{sld} | deletes a handshake domain
*SuperlinkMeSuperlink.HnsApi* | [**hnsTldCheckClaimed**](docs/HnsApi.md#hnsTldCheckClaimed) | **GET** /v1/hns/tld/{tld}/check-if-claimed/{address} | tests if the wallet has already claimed a domain for this TLD.
*SuperlinkMeSuperlink.HnsApi* | [**hnsTldValidate**](docs/HnsApi.md#hnsTldValidate) | **GET** /v1/hns/tld/{tld}/validate | HNSTLDValidation tests if the TLD blockchain DNS records are valid.
*SuperlinkMeSuperlink.LoginApi* | [**loginWithLink**](docs/LoginApi.md#loginWithLink) | **GET** /v1/login/link/{loginToken} | Login via a magic link
*SuperlinkMeSuperlink.LoginApi* | [**loginWithWallet**](docs/LoginApi.md#loginWithWallet) | **POST** /v1/login/wallet/{ownerAddress} | Login with a valid wallet
*SuperlinkMeSuperlink.LoginApi* | [**sendLoginEmail**](docs/LoginApi.md#sendLoginEmail) | **POST** /v1/login/email/{emailAddress} | Sends the e-mail that contains the magic link to login a specfic user
*SuperlinkMeSuperlink.MarketApi* | [**marketCryptoEstimate**](docs/MarketApi.md#marketCryptoEstimate) | **GET** /v1/market/crypto/estimate | CryptoEstimate returns the estimated conversion rates for supported crypto payment options
*SuperlinkMeSuperlink.MarketApi* | [**marketCryptoPurchase**](docs/MarketApi.md#marketCryptoPurchase) | **POST** /v1/market/crypto/purchase | CryptoPurchase returns the payment details required for crypto payment
*SuperlinkMeSuperlink.MarketApi* | [**marketOrder**](docs/MarketApi.md#marketOrder) | **GET** /v1/market/order/{orderID} | Returns order information
*SuperlinkMeSuperlink.MarketApi* | [**marketPurchase**](docs/MarketApi.md#marketPurchase) | **POST** /v1/market/purchase | Purchase returns the payment details required by Stripe
*SuperlinkMeSuperlink.MarketApi* | [**marketSearch**](docs/MarketApi.md#marketSearch) | **POST** /v1/market/search | Returns market listings
*SuperlinkMeSuperlink.MarketApi* | [**marketSuggestion**](docs/MarketApi.md#marketSuggestion) | **POST** /v1/market/suggest | Returns market listings for suggestions
*SuperlinkMeSuperlink.NftApi* | [**getTokenImageByDomain**](docs/NftApi.md#getTokenImageByDomain) | **GET** /v1/card-image/{domain}.svg | Returns a SVG image for a Superlink NFT
*SuperlinkMeSuperlink.NftApi* | [**getTokenMetadataByDomain**](docs/NftApi.md#getTokenMetadataByDomain) | **GET** /v1/metadata/{domain} | Returns metadata usually associated with NFTs uri
*SuperlinkMeSuperlink.PartnerApi* | [**createAccessToken**](docs/PartnerApi.md#createAccessToken) | **POST** /v1/partner/access-token | Creates an admin token for a partner
*SuperlinkMeSuperlink.PartnerApi* | [**deleteAccessToken**](docs/PartnerApi.md#deleteAccessToken) | **DELETE** /v1/partner/access-token | Deletes an access token
*SuperlinkMeSuperlink.PartnerApi* | [**listAccessTokens**](docs/PartnerApi.md#listAccessTokens) | **GET** /v1/partner/access-token | Lists access tokens for a partner
*SuperlinkMeSuperlink.PartnerApi* | [**partnerPurchases**](docs/PartnerApi.md#partnerPurchases) | **GET** /v1/partner/purchases | Returns a list of all purchases
*SuperlinkMeSuperlink.ProveApi* | [**getEthWalletMessage**](docs/ProveApi.md#getEthWalletMessage) | **GET** /v1/prove/wallet/eth/{ownerAddress} | Get message which should be signed by an eth wallet as proof of ownership
*SuperlinkMeSuperlink.ResolutionApi* | [**resolveDataByAddress**](docs/ResolutionApi.md#resolveDataByAddress) | **GET** /v1/reverse/{address} | Resolves wallets and DNS records for an address
*SuperlinkMeSuperlink.ResolutionApi* | [**resolveDataByDomain**](docs/ResolutionApi.md#resolveDataByDomain) | **GET** /v1/resolve/{domain} | Resolves wallets and DNS records for a domain
*SuperlinkMeSuperlink.SubdomainApi* | [**parentdomainPurchase**](docs/SubdomainApi.md#parentdomainPurchase) | **POST** /v1/parentdomains/{parentDomain}/buy | Purchases and sets up a parent domain for use with ens subdomains
*SuperlinkMeSuperlink.SubdomainApi* | [**parentdomainSearch**](docs/SubdomainApi.md#parentdomainSearch) | **GET** /v1/parentdomains/{parentDomain}/search | Returns a list of available parent-domains provided the preferred parent ddomain
*SuperlinkMeSuperlink.SubdomainApi* | [**parentdomainValidation**](docs/SubdomainApi.md#parentdomainValidation) | **GET** /v1/parentdomains/{parentDomain} | Validates if parent domain is correctly configured for use with ens subdomains
*SuperlinkMeSuperlink.SubdomainApi* | [**subdomainAvailable**](docs/SubdomainApi.md#subdomainAvailable) | **GET** /v1/parentdomains/{parentDomain}/subdomains/{subDomainName} | Returns subdomain availability
*SuperlinkMeSuperlink.SubdomainApi* | [**subdomainClaimed**](docs/SubdomainApi.md#subdomainClaimed) | **GET** /v1/parentdomains/{parentDomain}/claimed/{ethAddress} | Returns subdomain availability
*SuperlinkMeSuperlink.SubdomainApi* | [**subdomainInvalidateClaimRateLimit**](docs/SubdomainApi.md#subdomainInvalidateClaimRateLimit) | **DELETE** /v1/parentdomains/{parentDomain}/invalidate-claim-rate-limit | Invalidates the claim rate limit for the current IP
*SuperlinkMeSuperlink.SubdomainApi* | [**subdomainList**](docs/SubdomainApi.md#subdomainList) | **GET** /v1/parentdomains/{parentDomain}/list | Paginates over all subdomains in descending order of the creation date
*SuperlinkMeSuperlink.SubdomainApi* | [**subdomainMint**](docs/SubdomainApi.md#subdomainMint) | **POST** /v1/parentdomains/{parentDomain}/subdomains/{subDomainName} | Creates a subdomain for provided parentdomain
*SuperlinkMeSuperlink.SubdomainApi* | [**subdomainMintSig**](docs/SubdomainApi.md#subdomainMintSig) | **POST** /v1/parentdomains/{parentDomain}/subdomains/{subDomainName}/mint-with-sig | Creates a subdomain for provided parentdomain with signature
*SuperlinkMeSuperlink.SubdomainApi* | [**subdomainPerDay**](docs/SubdomainApi.md#subdomainPerDay) | **GET** /v1/parentdomains/{parentDomain}/per-day | Paginates over per-day aggregated counts for subdomains created given a parentdomain
*SuperlinkMeSuperlink.SubdomainApi* | [**subdomainResolve**](docs/SubdomainApi.md#subdomainResolve) | **GET** /v1/parentdomains/{parentDomain}/subdomains/{subDomainName}/resolve | Returns resolution of a provided subdomain
*SuperlinkMeSuperlink.SubdomainApi* | [**subdomainReverseResolve**](docs/SubdomainApi.md#subdomainReverseResolve) | **GET** /v1/parentdomains/{parentDomain}/addresses/{ethAddress}/reverse-resolve | Returns reverse-resolution of a provided eth address limited to provided parentdomain
*SuperlinkMeSuperlink.SubdomainApi* | [**subdomainRevoke**](docs/SubdomainApi.md#subdomainRevoke) | **DELETE** /v1/parentdomains/{parentDomain}/subdomains/{subDomainName} | Deletes a subdomain for provided parentdomain (Omnipotent)
*SuperlinkMeSuperlink.SubdomainApi* | [**subdomainTotal**](docs/SubdomainApi.md#subdomainTotal) | **GET** /v1/parentdomains/{parentDomain}/total | Returns the total number of subdomains registered to parentdomain


## Documentation for Models

 - [SuperlinkMeSuperlink.ApiAccessTokenCreateRequest](docs/ApiAccessTokenCreateRequest.md)
 - [SuperlinkMeSuperlink.ApiAccessTokenDeleteRequest](docs/ApiAccessTokenDeleteRequest.md)
 - [SuperlinkMeSuperlink.ApiAccessTokenResponse](docs/ApiAccessTokenResponse.md)
 - [SuperlinkMeSuperlink.ApiAddressRecord](docs/ApiAddressRecord.md)
 - [SuperlinkMeSuperlink.ApiAdminAccessTokenCreateRequest](docs/ApiAdminAccessTokenCreateRequest.md)
 - [SuperlinkMeSuperlink.ApiAdminPartnerCreateRequest](docs/ApiAdminPartnerCreateRequest.md)
 - [SuperlinkMeSuperlink.ApiBadRequestResponse](docs/ApiBadRequestResponse.md)
 - [SuperlinkMeSuperlink.ApiCoin](docs/ApiCoin.md)
 - [SuperlinkMeSuperlink.ApiCryptoPurchaseRequest](docs/ApiCryptoPurchaseRequest.md)
 - [SuperlinkMeSuperlink.ApiDNSRecord](docs/ApiDNSRecord.md)
 - [SuperlinkMeSuperlink.ApiDomainBasicInformation](docs/ApiDomainBasicInformation.md)
 - [SuperlinkMeSuperlink.ApiDomainMetadataAttribute](docs/ApiDomainMetadataAttribute.md)
 - [SuperlinkMeSuperlink.ApiDomainMetadataResponse](docs/ApiDomainMetadataResponse.md)
 - [SuperlinkMeSuperlink.ApiErrorResponse](docs/ApiErrorResponse.md)
 - [SuperlinkMeSuperlink.ApiGetAllDomainsResponse](docs/ApiGetAllDomainsResponse.md)
 - [SuperlinkMeSuperlink.ApiHNSBlockchainRecords](docs/ApiHNSBlockchainRecords.md)
 - [SuperlinkMeSuperlink.ApiHNSCreateDomainRequest](docs/ApiHNSCreateDomainRequest.md)
 - [SuperlinkMeSuperlink.ApiHNSCreateDomainWithWalletRequest](docs/ApiHNSCreateDomainWithWalletRequest.md)
 - [SuperlinkMeSuperlink.ApiHNSDomainAvailableResponse](docs/ApiHNSDomainAvailableResponse.md)
 - [SuperlinkMeSuperlink.ApiHNSRegisterTLDRequest](docs/ApiHNSRegisterTLDRequest.md)
 - [SuperlinkMeSuperlink.ApiHNSRegisterTLDResponse](docs/ApiHNSRegisterTLDResponse.md)
 - [SuperlinkMeSuperlink.ApiInternalServerErrorResponse](docs/ApiInternalServerErrorResponse.md)
 - [SuperlinkMeSuperlink.ApiMarketCryptoEstimation](docs/ApiMarketCryptoEstimation.md)
 - [SuperlinkMeSuperlink.ApiMarketCryptoEstimationResponse](docs/ApiMarketCryptoEstimationResponse.md)
 - [SuperlinkMeSuperlink.ApiMarketCryptoPurchaseResponse](docs/ApiMarketCryptoPurchaseResponse.md)
 - [SuperlinkMeSuperlink.ApiMarketListing](docs/ApiMarketListing.md)
 - [SuperlinkMeSuperlink.ApiMarketPurchaseResponse](docs/ApiMarketPurchaseResponse.md)
 - [SuperlinkMeSuperlink.ApiMarketSearchRequest](docs/ApiMarketSearchRequest.md)
 - [SuperlinkMeSuperlink.ApiMarketSearchResponse](docs/ApiMarketSearchResponse.md)
 - [SuperlinkMeSuperlink.ApiMarketSuggestRequest](docs/ApiMarketSuggestRequest.md)
 - [SuperlinkMeSuperlink.ApiMarketplaceOrderResponse](docs/ApiMarketplaceOrderResponse.md)
 - [SuperlinkMeSuperlink.ApiNameService](docs/ApiNameService.md)
 - [SuperlinkMeSuperlink.ApiParentDomainPurchaseRequest](docs/ApiParentDomainPurchaseRequest.md)
 - [SuperlinkMeSuperlink.ApiParentDomainPurchaseRequestDomainContactDetails](docs/ApiParentDomainPurchaseRequestDomainContactDetails.md)
 - [SuperlinkMeSuperlink.ApiParentDomainSearchResponse](docs/ApiParentDomainSearchResponse.md)
 - [SuperlinkMeSuperlink.ApiParentDomainValidationResponse](docs/ApiParentDomainValidationResponse.md)
 - [SuperlinkMeSuperlink.ApiPartnerResponse](docs/ApiPartnerResponse.md)
 - [SuperlinkMeSuperlink.ApiPurchaseListResponse](docs/ApiPurchaseListResponse.md)
 - [SuperlinkMeSuperlink.ApiPurchaseRequest](docs/ApiPurchaseRequest.md)
 - [SuperlinkMeSuperlink.ApiPurchaseResponse](docs/ApiPurchaseResponse.md)
 - [SuperlinkMeSuperlink.ApiResolveDomainResponse](docs/ApiResolveDomainResponse.md)
 - [SuperlinkMeSuperlink.ApiReverseResolutionDeleteRequest](docs/ApiReverseResolutionDeleteRequest.md)
 - [SuperlinkMeSuperlink.ApiSetReverseAddressRequest](docs/ApiSetReverseAddressRequest.md)
 - [SuperlinkMeSuperlink.ApiSubDomainAvailableResponse](docs/ApiSubDomainAvailableResponse.md)
 - [SuperlinkMeSuperlink.ApiSubDomainItem](docs/ApiSubDomainItem.md)
 - [SuperlinkMeSuperlink.ApiSubDomainListResponse](docs/ApiSubDomainListResponse.md)
 - [SuperlinkMeSuperlink.ApiSubDomainMintRequest](docs/ApiSubDomainMintRequest.md)
 - [SuperlinkMeSuperlink.ApiSubDomainMintWithSigRequest](docs/ApiSubDomainMintWithSigRequest.md)
 - [SuperlinkMeSuperlink.ApiSubDomainNameData](docs/ApiSubDomainNameData.md)
 - [SuperlinkMeSuperlink.ApiSubDomainPerDayCount](docs/ApiSubDomainPerDayCount.md)
 - [SuperlinkMeSuperlink.ApiSubDomainPerDayResponse](docs/ApiSubDomainPerDayResponse.md)
 - [SuperlinkMeSuperlink.ApiSubDomainResolveResponse](docs/ApiSubDomainResolveResponse.md)
 - [SuperlinkMeSuperlink.ApiSubDomainReverseResolveResponse](docs/ApiSubDomainReverseResolveResponse.md)
 - [SuperlinkMeSuperlink.ApiSubDomainTotalResponse](docs/ApiSubDomainTotalResponse.md)
 - [SuperlinkMeSuperlink.ApiSubdomainStatus](docs/ApiSubdomainStatus.md)
 - [SuperlinkMeSuperlink.ApiTXTRecord](docs/ApiTXTRecord.md)
 - [SuperlinkMeSuperlink.ApiWalletData](docs/ApiWalletData.md)
 - [SuperlinkMeSuperlink.ApiWalletLoginRequest](docs/ApiWalletLoginRequest.md)
 - [SuperlinkMeSuperlink.ApiWalletMessageResponse](docs/ApiWalletMessageResponse.md)
 - [SuperlinkMeSuperlink.DataAccessTokenType](docs/DataAccessTokenType.md)


## Documentation for Authorization


Authentication schemes defined for the API:
### BearerAuth


- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header