@superlink-me/superlink v0.5.0

@superlink-me/superlink

SuperlinkMeSuperlink - JavaScript client for @superlink-me/superlink API for Superlink This SDK is automatically generated by the OpenAPI Generator 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

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install @superlink-me/superlink --save

Finally, you need to build the module:

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:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

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:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

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:

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

For browser

The library also works in the browser environment via npm and browserify. 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):

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:

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

Getting Started

Please follow the installation instruction and execute the following JS code:

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

Documentation for Models

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

Documentation for Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header